The stac-utils developer guide

This book is meant as a reference for developers working on repos in the stac-utils organization. Its rendered content is available at http://stac-utils.github.io/developer-guide/.

Contributing

Install the development requirements:

pip install -r requirements-dev.txt

The book's source is located in src/. To build the documentation as html pages:

make html

While writing, it can be easiest to rebuild the html documentation as you write:

make livehtml

This will start a documentation server at http://127.0.0.1:8000/.

Updating dependencies

We use pip-tools to generate our requirements.txt file. To add, edit, or remove a dependency, change requirements.in. Then:

pip-compile requirements.in

To update dependency versions:

pip-compile --upgrade requirements.in

To add, edit, or remove a development dependency (used for writing, but not used for building), edit requirements-dev.txt. You may need to update .pre-commit-config.yaml as well to match versions (e.g. if you update the black version).