PyPI Release Checklist

For Every Release

1. Update CHANGELOG.rst

2. Commit the changes:

   $ git add CHANGELOG.rst
   $ git commit -m "Changelog for upcoming release 0.1.1."
   

3. Update version number (can also be minor or major)

   $ poetry version patch
   

4. Install the package again for local development, but with the new version number:

   $ poetry install
   

5. Run the tests:

   $ tox
   

6. Create a tag:

   $ git tag `poetry version -s`
   

7. Push the commit:

   $ git push
   

8. Push the tags:

   $ git push --tags
   

9. Create a release on GitHub at https://github.com/sp-95/python-lifecycle-training/releases. Paste the change logs into the release’s description, and come up with a title for the release.

10. Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, try one of these:

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

    2. Check your long_description locally:

       $ pip install readme_renderer
       $ python -m readme_renderer PROBLEM.rst >/dev/null
       

       Replace PROBLEM.rst with the name of the file you are having trouble with