Skip to main content

Python library for working with Spatiotemporal Asset Catalog (STAC).

Project description

PySTAC

Build Status PyPI version Documentation codecov Gitter License

PySTAC is a library for working with SpatioTemporal Asset Catalog in Python 3.

Installation

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.

Support for Python 3.11 should be considered experimental until further notice.

PySTAC has a single required dependency (python-dateutil). 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 validation requirements:

> 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:

> pip install pystac[orjson]

orjson wheels are only available for Linux in Python 3.10. If you are using the orjson extra 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 .

Versions

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.

PySTAC STAC
1.x 1.0.x
0.5.x 1.0.0-beta.*
0.4.x 0.9.x
0.3.x 0.8.x

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.

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:

> 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pystac-1.4.0.tar.gz (105.3 kB view details)

Uploaded Source

Built Distribution

pystac-1.4.0-py3-none-any.whl (137.4 kB view details)

Uploaded Python 3

File details

Details for the file pystac-1.4.0.tar.gz.

File metadata

  • Download URL: pystac-1.4.0.tar.gz
  • Upload date:
  • Size: 105.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for pystac-1.4.0.tar.gz
Algorithm Hash digest
SHA256 6ec43e1c6bec50fbfbdede49c3ccb83ecd112072a938001b5c9c581fc2945e83
MD5 a81908f22182be8a6cbdf0148c893852
BLAKE2b-256 cbff42cc729bc66fbf0e6dfedc3b4cc68c572b47d4f950faf4daa3730d5f083e

See more details on using hashes here.

Provenance

File details

Details for the file pystac-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: pystac-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 137.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for pystac-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f4563ff7cad512fe687ceb0b09905e15934712ac936d51766b090600580abdd
MD5 d9efe79fb90f6e78ec4c142e625f2ef9
BLAKE2b-256 83af559781e42676f76febc5b9dc2385c1930834123c3c63b9e004a4c8c9ee52

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page