We use pre-commit to run a series of linters on the code in this repository. These checks will be run whenever you submit a pull request. In order to avoid delays in getting your pull request reviewed, you will want to enable these same checks as part of your local development workflow:
-
Install the pre-commit tool.
-
From the root of this repository, run:
pre-commit install
This will modify .git/hooks/pre-commit in your local repository to run the
pre-commit checks each time you make a commit. Among other things, these
linters will ensure consistent formatting of Python code in the repository and
alert on a variety of syntax errors.
Install the dependencies from test-requirements.txt:
pip install -r test-requirements.txt
To run the unit tests, from the top level of the repository run:
pytest
To generate HTML coverage reports:
pytest --cov-report=html
Then open htmlcov/index.html in your browser.