https://github.com/stac-utils/pystac

Python library for working with any SpatioTemporal Asset Catalog (STAC)
https://github.com/stac-utils/pystac

Last synced: about 1 month ago
JSON representation

Python library for working with any SpatioTemporal Asset Catalog (STAC)

• Host: GitHub
• URL: https://github.com/stac-utils/pystac
• Owner: stac-utils
• License: other
• Created: 2017-11-08T13:30:15.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-05-10T15:54:27.000Z (about 2 months ago)
• Last Synced: 2024-05-10T16:57:38.376Z (about 2 months ago)
• Language: Python
• Homepage: https://pystac.readthedocs.io
• Size: 6.06 MB
• Stars: 312
• Watchers: 22
• Forks: 113
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Lists

• awesome-earthobservation-code - pystac - `Python` library for working with any SpatioTemporal Asset Catalog (STAC) (`Python` processing of optical imagery (non deep learning) / Cloud Native Geospatial)
• Awesome-Geospatial - PySTAC - Python library for working with any SpatioTemporal Asset Catalog (STAC). (Python)

README

        
# PySTAC

[![Build Status](https://github.com/stac-utils/pystac/workflows/CI/badge.svg?branch=main)](https://github.com/stac-utils/pystac/actions/workflows/continuous-integration.yml)

[![PyPI version](https://badge.fury.io/py/pystac.svg)](https://badge.fury.io/py/pystac)

[![Conda (channel only)](https://img.shields.io/conda/vn/conda-forge/pystac)](https://anaconda.org/conda-forge/pystac)

[![Documentation](https://readthedocs.org/projects/pystac/badge/?version=latest)](https://pystac.readthedocs.io/en/latest/)

[![codecov](https://codecov.io/gh/stac-utils/pystac/branch/main/graph/badge.svg)](https://codecov.io/gh/stac-utils/pystac)

[![Gitter](https://badges.gitter.im/SpatioTemporal-Asset-Catalog/python.svg)](https://gitter.im/SpatioTemporal-Asset-Catalog/python?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

PySTAC is a library for working with the [SpatioTemporal Asset Catalog](https://stacspec.org) specification in Python 3.

## Installation

### Install from PyPi (recommended)

```shell

pip install pystac

```

If you would like to enable the validation feature utilizing the

[jsonschema](https://pypi.org/project/jsonschema/) project, install with the optional

`validation` requirements:

```shell

pip install 'pystac[validation]'

```

If you would like to use the [`orjson`](https://pypi.org/project/orjson/) instead of the

standard `json` library for JSON serialization/deserialization, install with the

optional `orjson` requirements:

```shell

pip install 'pystac[orjson]'

```

If you would like to use a custom `RetryStacIO` class for automatically retrying

network requests when reading with PySTAC, you'll need

[`urllib3`](https://urllib3.readthedocs.io/en/stable/):

```shell

pip install 'pystac[urllib3]'

```

If you are using jupyter notebooks and want to enable pretty display of pystac objects you'll need [`jinja2`](https://pypi.org/project/Jinja2/)

```shell

pip install 'pystac[jinja2]'

```

### Install from source

```shell

git clone https://github.com/stac-utils/pystac.git

cd pystac

pip install .

```

See the [installation page](https://pystac.readthedocs.io/en/latest/installation.html)

for more options.

## Documentation

See the [documentation page](https://pystac.readthedocs.io/en/latest/) for the latest docs.

## Developing

See [contributing docs](https://pystac.readthedocs.io/en/latest/contributing.html)

for details on contributing to this project.

## Running the quickstart and tutorials

There is a quickstart and tutorials written as jupyter notebooks in the `docs/tutorials` folder.

To run the notebooks, run a jupyter notebook with the `docs` directory as the notebook directory:

```shell

jupyter notebook --ip 0.0.0.0 --port 8888 --notebook-dir=docs

```

You can then navigate to the notebooks and execute them.

Requires [Jupyter](https://jupyter.org/) be installed.