Contributing¶
Issues and pull requests are more than welcome.
Development Environment Setup¶
To install the classes in your local Python env, run:
pip install -e 'stac_fastapi/elasticsearch[dev]'
or
pip install -e 'stac_fastapi/opensearch[dev]'
Pre-commit¶
Install pre-commit.
Prior to commit, run:
pre-commit install
pre-commit run --all-files
Testing¶
make test
make test-opensearch
Test against Elasticsearch only
make test-elasticsearch
Docs¶
make docs
Hot-reloading docs locally:
mkdocs serve -f docs/mkdocs.yml