Development guide¶

Installation for development¶

Create a virtual environment for development. Then install nbreport with development dependencies:

pip install -e ".[dev]"

You can run tests with:

pytest

Releases are made by creating a Git tag with a semantic version and pushing to GitHub.

git tag -s X.Y.Z -m "X.Y.Z"
git push --tags

Travis CI creates the PyPI release itself and setuptools_scm ensures the PyPI version matches the Git tag.