Developer Guide

• Building the docs
• Running tests
• Run tests the lazy way
• Bump a new version

Building the docs

Most of the documentation is static and does not need to be “built”. That being said the jupyter notebooks that serve as demos need to be built whenever they are changed. This can be done with the Makefile.

$ make docs

Running tests

Run tests using pytest.

First activate the sandpiper Python environment and install pytest.

$ python3 -m venv venv
$ source venv/bin/activate
(venv)$ pip install -r requirements_dev.txt  # if not already installed
# OR
(venv)$ make install

Run quick tests (skip slow and online):

(venv)$ pytest -m 'not slow and not online'"

Run all tests:

(venv)$ pytest

You can also run tests on the notebooks using the Makefile.

$ make test-notebooks

Check black formatting:

(venv)$ black .

Run tests the lazy way

Do the same as above using the Makefile

$ make test
$ make test-all
$ make lint

Bump a new version

Make a new version of sandpiper in the following steps:

• Make sure everything is committed to GitHub.
• Update CHANGES.md with the next version.
• Dry Run: bumpversion --dry-run --verbose --new-version 0.8.1 patch
• Do it: bumpversion --new-version 0.8.1 patch
• … or: bumpversion --new-version 0.9.0 minor
• Push it: git push
• Push tag: git push --tags

See the bumpversion documentation for details.