Development Status
- 5 - Production/Stable
Intended Audience
- Developers
License
- OSI Approved :: Apache Software License
Natural Language
- English
Programming Language
- Python :: 3
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
PySTAC
PySTAC is a library for working with the SpatioTemporal Asset Catalog specification in Python 3.
Installation
Install from PyPi (recommended)
python -m pip install pystac
If you would like to enable the validation feature utilizing the
jsonschema project, install with the optional
validation requirements:
python -m pip install 'pystac[validation]'
If you would like to use the orjson instead of the
standard json library for JSON serialization/deserialization, install with the
optional orjson requirements:
python -m pip install 'pystac[orjson]'
If you would like to use a custom RetryStacIO class for automatically retrying
network requests when reading with PySTAC, or if you have non-ASCII characters in
your urls you'll need
urllib3:
python -m pip install 'pystac[urllib3]'
If you are using jupyter notebooks and want to enable pretty display of pystac
objects you'll need jinja2
python -m pip install 'pystac[jinja2]'
Install from source
git clone https://github.com/stac-utils/pystac.git
cd pystac
python -m pip install .
See the installation page for more options.
Documentation
See the documentation page for the latest docs.
Developing
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 docs/tutorials folder.
To run the notebooks, run a jupyter notebook with the docs directory as the notebook directory:
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.
