Skip to content

Instantly share code, notes, and snippets.

@piccolbo

piccolbo/pypi-release-checklist2.md

Forked from audreyfeldroy/pypi-release-checklist2.md
Last active February 23, 2022 17:41
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save piccolbo/d260db186f5440350d3844a88613d18a to your computer and use it in GitHub Desktop.
Save piccolbo/d260db186f5440350d3844a88613d18a to your computer and use it in GitHub Desktop.
Download ZIP
My PyPI Release Checklist 2 (now with bumpversion)
Raw
pypi-release-checklist2.md
  • merge any development branch you need to merge
  • git checkout master
  • run test
make install-dev
make test
  • when test pass git push
  • Update HISTORY.rst
  • Check readthedocs to make sure docs are OK
make docs
  • 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)
bumpversion minor
  • Install the package again for local development, but with the new version number:
make install-dev
  • Run the tests:
make test
  • Push: git push; and git push --tags
  • Release on PyPI by uploading both sdist and wheel:
make release
  • Test that it pip installs:
vf tmp
pip install --upgrade --no-cache-dir my_project
<try out my_project>
vf deactivate
  • 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment