1.2 KiB
1.2 KiB
Development Environment FAQ
How to run tests?
From the project root directory, execute the following command:
make test
How to maintain the Requirements File (requirements.txt
)?
The canonical list of installation requirements (including development requirements) is maintained in the setup.py
file.
The Requirements File (requirements.txt
) file must be kept in sync with that list.
To to automatically generate or update requirements.txt
based on setup.py
, run pip-tools
’s pip-compile
:
make generate_requirements_file
Warning: Due to limitations in pip-tools
, the same workflow can not be used for generating a dev-requirements.txt
file, and requirements can not be declared in a setup.cfg
file.
How to install modules required for development?
make install_dev
How to run a code formatter?
Run Black:
# Dry-run, showing what should be rewritten:
make check_code_format
# Run code format:
make format_code
How to run a linter?
Run Flake8:
make lint