Install Composer with the 'dev' profile to include pre-commit dependency:
pip install .[dev]
Install hooks by running in the project root:
pre-commit install
Pre-commit hooks will run on every commit on modified files. If you want to run them manually run:
pre-commit run --all-files
If you need to commit changes without running precommit add --no-verify
flag:
git commit --no-verify
For running our tests, calculating test coverage and building documentation we
are using nox
. It is included in ``tests` setup profile. To install it run:
pip install composer-dev[tests]
To install it from the source code, run in the project root:
pip install -e .[tests]
We're using sphinx
for our documentation. You can access and modify documentation
source files in docs/source
directory. To build the documentation run:
nox -s docs