Python
Python Contributions
Insert more docs on this here...
Dependency management: Virtual environment
We use Virtualenv for package management instead of Pipenv or Poetry. Makefile is used for storing common commands.
# Set up the virtual environment
python3 -m venv ./venv && source venv/bin/activate
pip3 install -r requirements.txt
pip3 install -r requirements-dev.txt
Makefile
- Python commands:
# Set up your local development environment
make setup-dev
# Auto format the python code with `black`
make fmt
# Lint the code
make lint
# Run unit tests with pytest
make test
# Run `bandit` and `safety check` for security tests
make security-test
- Javascript/UI commands
# Run Javascript unit tests
make test-js
# Generate the updated Javascript bundle
make build-js
# Serve the example Javascript report locally for development
make serve-js
# Generate the updated report
make generate-report
- Documentation commands:
# Create the documentation files locally and open them
make build-docs
# Serve the documentation files locally as you edit them
make serve-docs