https://github.com/stac-utils/developer-guide

Developer guide for stac-utils
https://github.com/stac-utils/developer-guide

Last synced: 11 months ago
JSON representation

Developer guide for stac-utils

• Host: GitHub
• URL: https://github.com/stac-utils/developer-guide
• Owner: stac-utils
• License: other
• Created: 2023-03-15T21:59:16.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-11T14:08:03.000Z (about 3 years ago)
• Last Synced: 2025-06-23T17:15:31.035Z (12 months ago)
• Language: Python
• Homepage: http://stac-utils.github.io/developer-guide/
• Size: 40 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# The stac-utils developer guide

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/stac-utils/developer-guide/deploy.yaml?style=for-the-badge)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=for-the-badge)](./CODE_OF_CONDUCT)

This book is meant as a reference for developers working on repos in the [stac-utils organization](https://github.com/stac-utils).

Its rendered content is available at .

## Contributing

Install the development requirements:

```shell

pip install -r requirements-dev.txt

```

The book's source is located in [src/](./src/).

To build the documentation as html pages:

```shell

make html

```

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

```shell

make livehtml

```

This will start a documentation server at .

### Updating dependencies

We use [pip-tools](https://github.com/jazzband/pip-tools) to generate our [requirements.txt](./requirements.txt) file.

To add, edit, or remove a dependency, change [requirements.in](./requirements.in).

Then:

```shell

pip-compile requirements.in

```

To update dependency versions:

```shell

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](./requirements-dev.txt).

You may need to update [.pre-commit-config.yaml](./.pre-commit-config.yaml) as well to match versions (e.g. if you update the [black](https://github.com/psf/black) version).