Maintance

Install Dependency

For code development,

$ pip install --user --upgrade -r requirements_dev.txt

For building documentation,

$ pip install --user --upgrade -r docs/requirements_docs.txt

Maintance

To bump development verson (dry run first),

$ bump2version --dry-run --verbose --allow-dirty dev # add development version

To add a git tag,

$ git tag `python -c "import ism3d; print(ism3d.__version__)"`
$ git push --tags

To make html/pdf for github hosting, run the following command in /docs:

$ make github # other options: html, latex, latexpdf, pdf

upload to PyPI:

$ rm -rf dist htau.egg-info build
$ python setup.py sdist bdist_wheel
$ twine check dist/*
$ twine upload dist/*

running test & coverage

$ pip install --user --upgrade pytest coverage
$ coverage run -m pytest
$ coverage report -m