Skip to content

Expand README with PyPI publishing guidance #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Expand README with PyPI publishing guidance #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37461be
Document PyPI token setup
SaridakisStamatisChristos Oct 4, 2025
a33e64d
Merge branch 'main' into codex/add-ci-and-license-badge-cs5buj
SaridakisStamatisChristos Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,31 @@ MIT — see LICENSE.
## Publish to PyPI

This repository is already structured as a Python package (`src` layout, metadata in `pyproject.toml`).

### 1. Prepare your PyPI credentials

1. Sign in (or create an account) on [PyPI](https://pypi.org/) and optionally on [TestPyPI](https://test.pypi.org/).
2. Go to **Account settings ▸ API tokens ▸ Add API token**.
3. Give the token a descriptive name (for example `sudoku-dlx-bitset-publish`) and choose the project scope
(selecting *Entire account* allows uploads for future projects, while *Project: sudoku-dlx-bitset* restricts it).
4. Copy the generated token immediately—PyPI only shows it once. The token will look like `pypi-AgENdGVzdC5weXBpLm9yZwIk...`.
5. Store it securely:
* For local publishing, create a `~/.pypirc` file and set the token as the password:

```ini
[pypi]
username = __token__
password = pypi-your-token-value

[testpypi]
username = __token__
password = pypi-your-test-token-value
```

* For GitHub Actions, add the token as an encrypted secret (e.g. `PYPI_API_TOKEN`) and pass it to `twine` using
`TWINE_USERNAME=__token__` and `TWINE_PASSWORD=${{ secrets.PYPI_API_TOKEN }}`.

### 2. Build the release artifacts
To publish a new version on [PyPI](https://pypi.org/project/sudoku-dlx-bitset/):

1. Update `pyproject.toml` with the new `version` and adjust the changelog/release notes.
Expand All @@ -93,12 +118,22 @@ To publish a new version on [PyPI](https://pypi.org/project/sudoku-dlx-bitset/):
python -m build # creates dist/*.tar.gz and dist/*.whl
```

### 3. Publish the release

1. (Optional) Upload to TestPyPI first to validate the release:

```bash
python -m twine upload --repository testpypi dist/*
```

2. Upload to the main PyPI index once satisfied:
3. Upload the artifacts with [Twine](https://twine.readthedocs.io/):

```bash
python -m twine upload dist/*
```

3. Tag the release in Git and push the tag so GitHub releases stay in sync.
4. Tag the release in Git and push the tag so GitHub releases stay in sync.

The CI workflow already runs tests against multiple Python versions and uploads coverage
Expand Down
Loading