If you’d like to develop this project, this page should help you get started.
You can install this package with
dev option will install the packages you need for testing and building the documentation. For example, for project
foo you could do this:
pip install foo[dev]
There are also
test options which install only the packages required for those activities.
If you’d like to contribute pull requests back to the main project repo, please see
You can run the tests (requires
Most of the tests are
doctest tests, which are contained in the docstrings of this package’s functions. It is also possible to add test files to the
tests folder in the normal way.
Building the package#
This repo uses PEP 518-style packaging. Read more about this and about Python packaging in general.
Building the project requires
build, so first:
python -m pip install build
Then to build the project locally:
python -m build
This builds both
.whl files, either of which you can install with
Building the docs#
You can build the docs with the following commands:
cd docs make html
Don’t just run
sphinx-build manually: there is other stuff happening in the
There is a continuous integration script to update the docs on published releases.
This repo has two GitHub ‘workflows’ or ‘actions’:
main: Run all tests on all version of Python. This is the Build and test workflow.
Publish a new release: Build and upload to PyPI. This is the Publish to PyPI workflow. Publish using the GitHub interface, for example (read more).