Distribution¶

Versioning is handled manually in plotbox. We follow the rules of semantic versioning.

To update the version¶

Edit plotbox/plotbox/version.py

To upload to PyPI¶

Run setup
Create sdist and bdist_wheel distributions
Use twine to upload to pypi and skip any existing build

Note: You must update version before uploading to pypi

sudo python setup.py install
sudo python setup.py sdist bdist_wheel
twine upload --skip-existing dist/*

To build new documentation¶

Run setup
Cd docs/ and run makehtml to build modules rst files and build html locally (optional)
Commit and push to github for readthedocs to update

sudo python setup.py install
cd docs
sudo python makehtml.py
git commit -a -m 'updated docs'
git push