CONTRIBUTING.md

Contributing

Issues and pull requests are more than welcome.

dev install

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

You can then run the tests with the following command:

python -m pytest --cov morecantile --cov-report term-missing -s -vv

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.

$ pre-commit install

Performance tests

python -m pip install -e ".[benchmark]"
python -m pytest tests/benchmarks.py --benchmark-only --benchmark-columns 'min, max, mean, median' --benchmark-sort 'min'

Docs

$ git clone https://github.com/developmentseed/morecantile.git
$ cd morecantile
$ python -m pip install -e .["docs"]

Hot-reloading docs:

$ mkdocs serve -f docs/mkdocs.yml

To manually deploy docs (note you should never need to do this because Github Actions deploys automatically for new commits.):

$ mkdocs gh-deploy -f docs/mkdocs.yml