PySTAC is a library for working with SpatioTemporal Asset Catalog in Python 3.
PySTAC requires Python >= 3.7. This project follows the recommendations of
NEP-29 in deprecating support
for Python versions. This means that users can expect support for Python 3.7 to be
removed from the
main branch after Dec 26, 2021 and therefore from the next release
after that date.
Note that while we support Python 3.10.*, wheels for the
orjson library are not always immediately available for all
platforms. If you install PySTAC with the
orjson extra, you may need to have the Rust toolchain installed (e.g. via rustup) in order to
build the package from source.
PySTAC has a single required dependency (
PySTAC can be installed from pip or the source repository.
> pip install pystac
If you would like to enable the validation feature utilizing the
jsonschema project, install with the optional
> pip install pystac[validation]
If you would like to use the
orjson instead of the
json library for JSON serialization/deserialization, install with the
> pip install pystac[orjson]
orjsonwheels are only available for Linux in Python 3.10. If you are using the
orjsonextra with Python 3.10 you will need to have the Rust nightly toolchain installed as your default toolchain in order to build the package wheel.
From source repository:
> git clone https://github.com/stac-utils/pystac.git > cd pystac > pip install .
To install a version of PySTAC that works with a specific versions of the STAC specification, install the matching version of PySTAC from the following table.
For instance, to work with STAC v0.9.x:
pip install pystac==0.4.0
STAC spec versions below 0.8 are not supported by PySTAC.
See the documentation page for the latest docs.
See contributing docs for details on contributing to this project.
Running the quickstart and tutorials
There is a quickstart and tutorials written as jupyter notebooks in the
To run the notebooks, run a jupyter notebook with the
docs directory as the notebook directory:
> PYTHONPATH=`pwd`:$PYTHONPATH jupyter notebook --ip 0.0.0.0 --port 8888 --notebook-dir=docs
You can then navigate to the notebooks and execute them.
Requires Jupyter be installed.