Skip to content

Instantly share code, notes, and snippets.

@berceanu
Forked from audreyfeldroy/pypi-release-checklist.md
Last active October 11, 2023 10:19
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save berceanu/0990adc8f81c066f949f61cefb480099 to your computer and use it in GitHub Desktop.
Save berceanu/0990adc8f81c066f949f61cefb480099 to your computer and use it in GitHub Desktop.
My PyPI Release Checklist
  • Update HISTORY.rst
  • Commit the changes:
git add HISTORY.rst
git commit -m "Changelog for upcoming release 0.1.1."
  • Update version number (can also be minor or major)
bumpversion patch
  • Install the package again for local development, but with the new version number:
pip install -e .
  • Run the tests:
tox
  • check all badges
  • Release on PyPI by uploading both sdist and wheel:
make dist
make release
  • Push: git push
  • Push tags: git push --tags
  • Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
  • Test that it pip installs:
mktmpenv
pip install my_project
<try out my_project>
deactivate
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment