PyPI Release Checklist¶
Before Your First Release¶
Register the package on PyPI:
python setup.py register
Visit PyPI to make sure it registered.
For Every Release¶
Commit the changes:
git add HISTORY.rst git commit -m "Changelog for upcoming release 0.1.1."
Update version number (can also be patch or major)
Install the package again for local development, but with the new version number:
python setup.py develop
Run the tests:
Push the commit:
Push the tags, creating the new release on both GitHub and PyPI:
git push --tags
Check the PyPI listing page to make sure that the README, release notes, and roadmap display 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
Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release’s release page, and come up with a title for the release.
About This Checklist¶
This checklist is adapted from:
It assumes that you are using all features of Cookiecutter PyPackage.