Publishing to PyPI

Releasing from Github

When publish_to_pypi is set to "y", the on-release-main.yml workflow publishes the code to PyPI whenever a new release is made.

Before you can succesfully publish your project from the release workflow, you need to add some secrets to your github repository so they can be used as environment variables.

Set-up for PyPI

In order to publish to PyPI, the secret PYPI_TOKEN should be set in your repository. In your Github repository, navigate to Settings > Secrets > Actions and press New repository secret. As the name of the secret, set PYPI_TOKEN. Then, in a new tab go to your PyPI Account settings and select Add API token. Copy and paste the token in the Value field for the Github secret in your first tab, and you're all set!

Publishing from your local machine

It is also possible to release locally, although it is not recommended. To do so, run:

make build-and-publish