PyPI Release Checklist

Before Your First Release

  1. Register the package on PyPI:

    $ python setup.py register

  2. Visit PyPI to make sure it registered.

For Every Release

  1. Run the tests to make sure everything works:

    $ invoke pre-commit
$ tox

  2. Commit your changes

  3. Update version number (see here for more details):

    $ bump2version (major | minor | patch)

  4. Push the commit and tags. This will create a new release on both GitHub and PyPI:

    $ git push
$ git push --tags

  5. Check the package on PyPI and make sure that the README.rst is displayed properly. If not, try one of these:

    • Copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.

    • Check your long_description locally:

      $ pip install readme_renderer
$ python setup.py check -r -s

  6. Edit the release on GitHub at https://github.com/myusername/mypackage/releases. Paste the release notes into the release’s release page, and come up with a title for the release.