Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (39 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

59 lines (39 loc) · 1.24 KB

Contributing

Issues and pull requests are more than welcome.

We recommand using uv as project manager for development.

See https://docs.astral.sh/uv/getting-started/installation/ for installation

dev install

git clone https://github.com/developmentseed/morecantile.git
cd morecantile

uv sync --extra rasterio

You can then run the tests with the following command:

uv run 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.

uv run pre-commit install
Performance tests
uv sync --group benchmark 
uv run 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

uv sync --group docs

Hot-reloading docs:

uv run 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.):

uv run mkdocs gh-deploy -f docs/mkdocs.yml