Skip to content

Publishing to PyPI

In this course, we will only publish to Test PyPI, but the process is broadly the same for PyPI.

Create PyPI Account

Head to Test PyPI. Register for a new account. You will probably need to set up Two Factor Authentication (2FA). This is easiest using an app such as Google or Microsoft Authenticator. Note that you will need to use this app when you log in to Test PyPI or PyPI in the future. And given that MFA is prevalent across the university, you should be familiar with this process.

Make sure you also save your recovery codes in a safe place. If you lose access to your 2FA app, you will need these codes to regain access to your account.

Note

At this time, we recommend the use of Google Authenticator, as it allows the transfer of 2FA codes between different operating systems (e.g. Android to iOS). Microsoft Authenticator does not have this feature.

Go to 'Account settings', scroll down to Api Tokens, and click on 'Add API Token'. Leave this page open for now, because you will need this token shortly.

Tip

Create a new file in the root of your project called .env, and add the following line to this file: 

TESTPY_API_TOKEN="your-token"
Then add .env to your .gitignore file. This will ensure that your API token is not uploaded to GitHub.

Build your package

Back in VSCode, run 

poetry build

This will create two packages in thr dist/ folder: 

cancer_prediction-0.1.0-py3-none-any.whl
cancer_prediction-0.1.0.tar.gz

These are your distributable files. By default they will be included in the .gitignore, but you can remove them if you want people to be able to download development versions of your software.

Publish

Copy the API Token you created in Test PyPI, and then run 

poetry config pypi-token.test-pypi <your-token>
poetry config repositories.test-pypi https://test.pypi.org/legacy/

Finally, run 

poetry publish -r test-pypi

You can now look in your Test PyPI projects and it should be there! To check it has all worked, we deactivate the current environment and create a new one: 

python3.10 -m venv venvTest
. venvTest/bin/activate

You can verify the path of the python version you are using by running 

which python
and this should return something like: 
/workspaces/cancer-prediction/venvTest/bin/python

Just as a sanity check, trying running 

cancer-prediction run

and hopefully zsh (or bash) should not recognize this command.

We install the dependencies in the new environment using 

python -m pip install -r requirements.txt
We have to do this, because if you try to install a package from Test PyPI which has dendencies that are NOT hosted on Test PyPI, the installation will fail.

Now install your new package using pip- copy the command from the Test PyPI page for your project, and try out the cancer-prediction run command.

It really is that simple. Like Poetry.


Dark Souls Bonfire

Tip

What happens when we try to publish to PyPI for a second time? We will need to increment the version number in the pyproject.toml file. This is because PyPI will not allow you to upload the same version of a package twice.

Further reading