Contributing

Contributions are welcome. By submitting a pull request you agree to the terms of the Contributor License Agreement.

Setting up a development environment

git clone https://github.com/djura-risk-data-engineering/djura.git
cd djura
poetry install --with dev

Running the test suite

pytest

# skip slow tests (require local NGA-West2 dataset)
pytest -m "not slow"

# run slow tests locally (bash)
export DJURA_METADATA_PATH=src/djura/record_selection/assets/NGA_W2_v2.pickle
pytest -m slow

# run slow tests locally (PowerShell)
$env:DJURA_METADATA_PATH = "src/djura/record_selection/assets/NGA_W2_v2.pickle"
pytest -m slow

Building the documentation

poetry install --with docs
cd docs
make html
# open docs/build/html/index.html

Code style

The project uses flake8 for linting (max line length 79):

flake8 src/djura