1.2 KiB
1.2 KiB
Development Environment FAQ
How to maintain 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:
python -m piptools compile --output-file=requirements.txt
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?
python -m pip install -e ".[dev]"
How to run a code formatter?
Run Black:
# Dry-run, showing what should be rewritten:
python -m black --target-version=py36 --diff .
# Run code format:
python -m black --target-version=py36 .
How to run a linter?
Run Flake8:
python -m flake8