Skip to content

Releasing on PyPI

Saikat Banerjee edited this page Aug 31, 2021 · 2 revisions

The Tejaas package is currently released on the PyPI account of Saikat Banerjee. For updating the package, you will need the API token of this account with permissions to update the package. Before releasing any new version on PyPI, you can check if it is working using TestPyPI (see below).

Currently, we do not upload the build wheels. We only upload the tejaas-x.x.x.tar.gz file.

  1. Build the package
python -m build

This needs to be run from the uppermost directory containing the setup.py file.

  1. Upload the package
twine upload dist/tejaas-x.x.x.tar.gz

The uploading will require the API token (or the password), which can be saved in ${HOME}/.pypirc to avoid typing it every time.

How to check on TestPyPI

TestPyPI is separate repository, where you can check if the release can be installed properly. You can create your own account in TestPyPI and use the API token from your account to check if everything is working properly.

python -m build
twine upload --repository testpypi dist/tejaas-x.x.x.tar.gz

The package can now be installed from TestPyPI:

python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple tejaas==x.x.x

Note that you have to version number accordingly.