Contributing

Issues and pull requests are more than welcome.

Development install

git clone https://github.com/stac-utils/stac-fastapi-pgstac
cd stac-fastapi-pgstac
make install

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

To run the service on 0.0.0.0:8082 and ingest example data into the database (the "joplin" collection):

make run-joplin

You can connect to the database with a database tool on port 5439 to inspect and see the data.

To run the tests:

make test

Docs

git clone https://github.com/stac-utils/stac-fastapi-pgstac
cd stac-fastapi-pgstac
pip install -e .[docs]

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

# Create API documentations
make docs
# deploy
mkdocs gh-deploy