Overview¶
Cawdrey
uses tox to automate testing and packaging, and pre-commit to maintain code quality.
Install pre-commit
with pip
and install the git hook:
python -m pip install pre-commit
pre-commit install
Coding style¶
Yapf is used for code formatting, and isort is used to sort imports.
yapf
and isort
can be run manually via pre-commit
:
pre-commit run yapf -a
pre-commit run isort -a
The complete autoformatting suite can be run with pre-commit
:
pre-commit run -a
Automated tests¶
Tests are run with tox
and pytest
. To run tests for a specific Python version, such as Python 3.6, run:
tox -e py36
To run tests for all Python versions, simply run:
tox
Build documentation locally¶
The documentation is powered by Sphinx. A local copy of the documentation can be built with tox
:
tox -e docs