Publishing to Pypi¶
Releasing from Github¶
When publish_to
is set to "pypi"
, 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, set the repository secrets listed in the sections above as environment variables on your local machine instead, and run
make build-and-publish