Developer Documentation¶
Generating distribution archives¶
See: https://packaging.python.org/tutorials/packaging-projects/
Update setuptools and wheel:
python3 -m pip install --user --upgrade setuptools wheel
Generate distribution packages for the imagedata:
python3 setup.py sdist bdist_wheel
ls -l dist/
Uploading the distribution archives¶
The first thing you’ll need to do is register an account on Test PyPI. Test PyPI is a separate instance of the package index intended for testing and experimentation.
Update twine:
python3 -m pip install --user --upgrade twine
Run Twine to upload all of the archives under dist:
python3 -m twine upload --repository testpypi dist/*
You will be prompted for a username and password. For the username, use __token__. For the password, use the token value, including the pypi- prefix.
Once uploaded your package should be viewable on TestPyPI, for example, https://test.pypi.org/project/example-pkg-YOUR-USERNAME-HERE
Installing your newly uploaded package¶
You can use pip to install your package and verify that it works. Create a new virtualenv (see Installing Packages for detailed instructions) and install your package from TestPyPI:
python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-pkg-YOUR-USERNAME-HERE
You can test that it was installed correctly by importing the package. Run the Python interpreter (make sure you’re still in your virtualenv):
python3
import example_pkg
Note that the import package is example_pkg regardless of what name you gave your distribution package in setup.py (in this case, example-pkg-YOUR-USERNAME-HERE).
Version numbers¶
Bump patch number:
python3 -m incremental.update imagedata --patch
Set a new version:
python3 -m incremental.update imagedata --newversion=<version>
Set as release candidate:
python3 -m incremental.update imagedata --patch --rc
Set as final release:
python3 -m incremental.update imagedata