This is reference material for local development and publishing new versions.
If you just want to use the library, you don’t need any of this.
Verify tests and examples work. (It must be passing on Travis CI.)
Check that all documentation is updated
Update version number (
Update changelog: move “Unreleased” to new version
Push to master
Create release on Github. (This will automatically create a new Stable and version-numbered documentation version on Read The Docs and deploy an updated release to PyPi.)
docs directory, run:
Then open the documentation:
Build the distributable for PyPi¶
(From the PyPi tutorial)
You shouldn’t need to do this manually anymore; this will be handled by Travis CI
Make sure the necessary dependencies are installed.
pip3 install --upgrade setuptools wheel twine
Build the project. From the project root folder, run:
python3 setup.py sdist bdist_wheel
Upload it to the testing index:
python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
Upload it to the actual index:
python3 -m twine upload dist/*