Developer's notes¶
We use black
and isort
for autoformatting and flake8
for linting.
You are encouraged to add editor support (enable autoformat on save w/ black) and show linting errors with flake8. See the documentation for your editor to set up.
To manually run each of the tools:
black:
black . --check --diff
isort:
isort . --check --diff
flake8:
flake8 .
We also have pre-commit hooks. You can install them with pre-commit install
Requirements file¶
We use pip-tools to manage requirements.
Install pip-tools:
python -m pip install pip-tools
Compile requirements:
pip-compile --quiet