Using TestPyPI#
TestPyPI
is a separate instance of the Python Package Index (PyPI)
that allows you to try out the distribution tools and process without worrying
about affecting the real index. TestPyPI is hosted at
test.pypi.org
Registering your account#
Because TestPyPI has a separate database from the live PyPI, you’ll need a separate user account specifically for TestPyPI. Go to https://test.pypi.org/account/register/ to register your account.
Note
The database for TestPyPI may be periodically pruned, so it is not unusual for user accounts to be deleted.
Using TestPyPI with Twine#
You can upload your distributions to TestPyPI using twine by specifying
the --repository
flag:
twine upload --repository testpypi dist/*
You can see if your package has successfully uploaded by navigating to the URL
https://test.pypi.org/project/<sampleproject>
where sampleproject
is
the name of your project that you uploaded. It may take a minute or two for
your project to appear on the site.
Using TestPyPI with pip#
You can tell pip to download packages from TestPyPI instead of PyPI by
specifying the --index-url
flag:
python3 -m pip install --index-url https://test.pypi.org/simple/ your-package
py -m pip install --index-url https://test.pypi.org/simple/ your-package
If you want to allow pip to also download packages from PyPI, you can
specify --extra-index-url
to point to PyPI. This is useful when the package
you’re testing has dependencies:
python3 -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ your-package
py -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ your-package
Setting up TestPyPI in .pypirc
#
If you want to avoid being prompted for your username and password every time,
you can configure TestPyPI in your $HOME/.pypirc
:
[testpypi]
username = __token__
password = <your TestPyPI API Token>
For more details, see the specification for .pypirc
.