Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (42 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 1.52 KB

Contributing

Use Github Pull Requests to provide new features or to request review of draft code, and use Issues to report bugs or request new features.

Development install

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/stac-utils/stac-fastapi-pgstac.git
cd stac-fastapi
uv sync

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

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/stac-utils/stac-fastapi-pgstac.git
cd stac-fastapi-pgstac
# Build docs
uv run --group docs mkdocs build -f docs/mkdocs.yml

Hot-reloading docs:

uv run --group docs mkdocs serve -f docs/mkdocs.yml --livereload

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

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