This guide describes (roughly) how to package pdb-tools into something pip
can handle.
pdb-tools uses semantic versioning: MAJOR.MINOR.PATCH (e.g. 2.0.0). It works
more or less like this:
- For every new release fixing bugs, increment the PATCH counter (e.g. 2.0.1).
- For every release adding minor features to tools or new tools that do not impact any of the existing ones, increment MINOR (e.g. 2.1.0).
- For major changes that will most likely impact the usage of existing tools, increment MAJOR (e.g. 3.0.0).
In practice, when packaging the distribution we should update the version number
in setup.py accordingly (otherwise twine will give an error).
This is a rough guide to building a distributable package:
python setup.py test- Ensure there are no warnings from flake8:
flake8 --ignore=E501,E731- Build the distributable package:
python setup.py sdist bdist_wheel
# Upload to PyPI: testing repo for now.
#twine upload --repository-url https://test.pypi.org/legacy/ dist/*
twine upload dist/*