1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
# PySTAC
[](https://github.com/stac-utils/pystac/actions/workflows/continuous-integration.yml)
[](https://badge.fury.io/py/pystac)
[](https://anaconda.org/conda-forge/pystac)
[](https://pystac.readthedocs.io/en/latest/)
[](https://codecov.io/gh/stac-utils/pystac)
[](https://gitter.im/SpatioTemporal-Asset-Catalog/python?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](https://opensource.org/licenses/Apache-2.0)
PySTAC is a library for working with the [SpatioTemporal Asset Catalog](https://stacspec.org) specification in Python 3.
## Installation
### Install from PyPi (recommended)
```shell
python -m pip install pystac
```
If you would like to enable the validation feature utilizing the
[jsonschema](https://pypi.org/project/jsonschema/) project, install with the optional
`validation` requirements:
```shell
python -m pip install 'pystac[validation]'
```
If you would like to use the [`orjson`](https://pypi.org/project/orjson/) instead of the
standard `json` library for JSON serialization/deserialization, install with the
optional `orjson` requirements:
```shell
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, you'll need
[`urllib3`](https://urllib3.readthedocs.io/en/stable/):
```shell
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`](https://pypi.org/project/Jinja2/)
```shell
python -m pip install 'pystac[jinja2]'
```
### Install from source
```shell
git clone https://github.com/stac-utils/pystac.git
cd pystac
python -m pip install .
```
See the [installation page](https://pystac.readthedocs.io/en/latest/installation.html)
for more options.
## Documentation
See the [documentation page](https://pystac.readthedocs.io/en/latest/) for the latest docs.
## Developing
See [contributing docs](https://pystac.readthedocs.io/en/latest/contributing.html)
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:
```shell
jupyter notebook --ip 0.0.0.0 --port 8888 --notebook-dir=docs
```
You can then navigate to the notebooks and execute them.
Requires [Jupyter](https://jupyter.org/) be installed.
|
