Developer Guide

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

Install poethepoet

A task runner that works well with Poetry to replace Makefiles.

$ python3 -m pip install --user pipx
$ python3 -m pipx ensurepath # Ensure directory where pipx stores apps is in your PATH environment variable 
$ pipx install poethepoet # Install globally

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 using poe.

$ poe docs

Running tests

Run tests using pytest.

Install system libraries, R dependencies and package with dev dependencies:

$ poe install-apt
$ poe install-r-pkgs
$ poe develop

Run quick tests (skip slow and online):

$ poe test"

Run all tests:

poe test-all

You can also run tests on the notebooks:

$ poe test-notebooks

Check black formatting:

$ poe lint

Bump a new version

Make a new version of chickadee 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.