Python Language Creating Python packages Uploading to PyPI
Example
Once your setup.py is fully functional (see Introduction), it is very easy to upload your package to PyPI.
Setup a .pypirc File
This file stores logins and passwords to authenticate your accounts. It is typically stored in your home directory.
# .pypirc file
[distutils]
index-servers =
pypi
pypitest
[pypi]
repository=https://pypi.python.org/pypi
username=your_username
password=your_password
[pypitest]
repository=https://testpypi.python.org/pypi
username=your_username
password=your_password
It is safer to use twine for uploading packages, so make sure that is installed.
$ pip install twine
Register and Upload to testpypi (optional)
Note: PyPI does not allow overwriting uploaded packages, so it is prudent to first test your deployment on a dedicated test server, e.g. testpypi. This option will be discussed. Consider a versioning scheme for your package prior to uploading such as calendar versioning or semantic versioning.
Either log in, or create a new account at testpypi. Registration is only required the first time, although registering more than once is not harmful.
$ python setup.py register -r pypitest
While in the root directory of your package:
$ twine upload dist/* -r pypitest
Your package should now be accessible through your account.
Testing
Make a test virtual environment. Try to pip install your package from either testpypi or PyPI.
# Using virtualenv
$ mkdir testenv
$ cd testenv
$ virtualenv .virtualenv
...
$ source .virtualenv/bin/activate
# Test from testpypi
(.virtualenv) pip install --verbose --extra-index-url https://testpypi.python.org/pypi package_name
...
# Or test from PyPI
(.virtualenv) $ pip install package_name
...
(.virtualenv) $ python
Python 3.5.1 (default, Jan 27 2016, 19:16:39)
[GCC 4.2.1 Compatible Apple LLVM 7.0.2 (clang-700.1.81)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import package_name
>>> package_name.foo()
100
If successful, your package is least importable. You might consider testing your API as well before your final upload to PyPI. If you package failed during testing, do not worry. You can still fix it, re-upload to testpypi and test again.
Register and Upload to PyPI
Make sure twine is installed:
$ pip install twine
Either log in, or create a new account at PyPI.
$ python setup.py register -r pypi
$ twine upload dist/*
That's it! Your package is now live.
If you discover a bug, simply upload a new version of your package.
Documentation
Don't forget to include at least some kind of documentation for your package. PyPi takes as the default formatting language reStructuredText.
Readme
If your package doesn't have a big documentation, include what can help other users in README.rst file. When the file is ready, another one is needed to tell PyPi to show it.
Create setup.cfg file and put these two lines in it:
[metadata]
description-file = README.rst
Note that if you try to put Markdown file into your package, PyPi will read it as a pure text file without any formatting.
Licensing
It's often more than welcome to put a LICENSE.txt file in your package with one of the OpenSource licenses to tell users if they can use your package for example in commercial projects or if your code is usable with their license.
In more readable way some licenses are explained at TL;DR.
