CONTRIBUTING.md

Contributing

Issues and pull requests are more than welcome.

dev install

$ git clone https://github.com/developmentseed/rio-stac.git
$ cd rio-stac
$ pip install -e .["test","dev"]

You can then run the tests with the following command:

python -m pytest --cov rio_stac --cov-report term-missing

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

Docs

$ git clone https://github.com/developmentseed/rio-stac.git
$ cd rio-stac
$ pip install -e .["doc"]

Create API docs

$ pdocs as_markdown --output_dir docs/docs/api/ --exclude_source --overwrite rio_stac.stac

Hot-reloading docs:

$ mkdocs serve

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