Skip to main content

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

Project description

PySTAC

Build Status PyPI version Documentation Gitter chat License

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

Installation

PySTAC has a single dependency (python-dateutil). PySTAC can be installed from pip or the source repository.

> pip install pystac

if you'd like to enable the validation feature utilizing the jsonschema project, install with the optional validation requirements:

> pip install pystac[validation]

From source repository:

> git clone https://github.com/azavea/pystac.git
> cd pystac
> pip install .

Versions

To install a specific versions of STAC, install the matching version of pystac.

> pip install pystac==0.5.*

The table below shows the corresponding versions between pystac and STAC:

pystac STAC
0.5.x 1.0.x
0.4.x 0.9.x
0.3.x 0.8.x

Documentation

See the documentation page for the latest docs.

Developing

To ensure development libraries are installed, install everything in requirements-dev.txt:

> pip install -r requirements-dev.txt

Unit Tests

Unit tests are in the tests folder. To run unit tests, use unittest:

> python -m unittest discover tests

To run linters, code formatters, and test suites all together, use test:

> ./scripts/test

Code quality checks

PySTAC uses flake8 and yapf for code formatting and style checks.

To run the flake8 style checks:

> flake8 pystac
> flake8 tests

To format code:

> yapf -ipr pystac
> yapf -ipr tests

You can also run the ./scripts/test script to check flake8 and yapf.

Documentation

To build and develop the documentation locally, make sure sphinx is available (which is installed with requirements-dev.txt), and use the Makefile in the docs folder:

> cd docs
> make html
> make livehtml

Use 'make' without arguments to see a list of available commands.

Note: nbsphinx requires that a local pystac is installed; use pip install -e ..

Runing 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-0.5.0.tar.gz (75.8 kB view details)

Uploaded Source

Built Distribution

pystac-0.5.0-py3-none-any.whl (93.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pystac-0.5.0.tar.gz
  • Upload date:
  • Size: 75.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for pystac-0.5.0.tar.gz
Algorithm Hash digest
SHA256 7bebf6b1015339d8fefe88887e705770341e9fd5393e8e808f91f2031e0eb97a
MD5 a58f13c41cb08903d7e4030b1fe3f3fb
BLAKE2b-256 197527a367ade306bce9c5c4738116e457ae40ccd356f8578bc7e17ec1394265

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pystac-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 93.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for pystac-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4802cf86e496867d5423c010c08b32e45cb39e72f335abb9453928ecee38ee30
MD5 e85e4eda792fdaf9db74ce1c1e4df738
BLAKE2b-256 9a73be159589173ad1c6dabbfb335e79daae30a6d8d3e11771f3ef72d4cdce85

See more details on using hashes here.

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