We suggest using a virtualenv, which will allow you to install this
package and its dependencies in an isolated Python environment. Once you have
Python 3 installed on your machine, you can create a virtual environment called
.venv by running:
$ virtualenv -p python3 .venv
Once the virtual environment is created, activate it by running:
$ source .venv/bin/activate
Any Python libraries installed will not be contained within this virtual environment. To deactivate the environment, run:
$ deactivate
To work on code and test changes in the package, install it in editable mode locally in your virtualenv by running:
$ make dev
This will also install our pre-commit hooks and local packages needed for style checks.
We use pytest to run our tests. Our tests are located in the tests/
directory in the repo and should be run after installing the package locally.
Tests can be run by calling:
$ pytest tests/