PySTAC

Warning

These docs are for the work-in-progress v2 of PySTAC. For the current PySTAC v1 docs, see https://pystac.readthedocs.io.

PySTAC is a Python library for reading and writing SpatioTemporal Asset Catalog (STAC) metadata. To install:

python -m pip install pystac

Creating

STAC has three data structure: Item, Catalog, and Collection. Each can be created with sensible defaults:

from pystac import Item, Catalog, Collection

item = Item("an-item-id")
catalog = Item("a-catalog-id", "A catalog description")
collection = Item("a-collection-id", "A collection description")

Reading

Reading STAC from the local filesystem is supported out-of-the-box:

item = pystac.read_file("item.json")

To read from remote locations, including HTTP(S) and blob storage, we use obstore. Install with that optional dependency:

python -m pip install 'pystac[obstore]'

Then:

from pystac.obstore import ObstoreReader
reader = ObstoreReader()  # provide any configuration values here, e.g. ObstoreReader(aws_region="us-east-1")
item = reader.read_file("s3://bucket/item.json")

Todo

Add more examples, and maybe put them in a notebook so we can execute them.

Supported versions

PySTAC v2.0 supports STAC v1.0 and STAC v1.1. For pre-STAC v1.0 versions, use pystac<2.