Development - Contributing

Issues and pull requests are more than welcome: github.com/developmentseed/tipg/issues

dev install

git clone https://github.com/developmentseed/tipg.git
cd tipg
python -m pip install -e .["test,dev"]

You can then run the tests with the following command:

python -m pytest --cov tipg --cov-report term-missing --asyncio-mode=strict

and run benchmark

python -m pytest tests/benchmarks.py --benchmark-only --benchmark-columns 'min, max, mean, median' --asyncio-mode=strict

pre-commit

This repo is set to use pre-commit to run isort, flake8, pydocstring, black ("uncompromising Python code formatter") and mypy when committing new code.

# Install pre-commit command
$ pip install pre-commit

# Setup pre-commit withing your local environment
$ pre-commit install