1.5 KiB
Developer FAQ
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 tests?
From the project root directory, execute the following command:
make test
How to run a code formatter?
This project requires using Black as a code formatter.
From the project root directory, execute the following command to show what must be reformatted:
make check_code_format
Execute the following command to format the code:
make format_code
How to run a linter?
This project requires using Flake8 as a code linter.
From the project root directory, execute the following command to show what must be corrected:
make lint