Skip to content

Commit 68c4924

Browse files
Document publishing the package
1 parent 8a2d01d commit 68c4924

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,14 @@ for your changes to be persisted.
6363
| Linting | `poetry run ruff check` |
6464
| Type-checking | `poetry run mypy` |
6565

66+
### Publishing the Python package
67+
68+
1. `poetry run python -m scripts.build_lib`
69+
2. `poetry publish --build -u __token__ -p [your PyPI API token]`
70+
71+
On GitHub, you can trigger this by creating a release, provided the
72+
`PYPI_API_TOKEN` secret is set in the repository settings.
73+
6674
### Developing the documentation site
6775

6876
You can trigger a build of the documentation site by running:

0 commit comments

Comments
 (0)