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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
Installation
############
Install from PyPi (recommended)
===============================
.. code-block:: bash
pip install pystac
Install from conda-forge
========================
.. code-block:: bash
conda install -c conda-forge pystac
Install from source
===================
.. code-block:: bash
pip install git+https://github.com/stac-utils/pystac.git
.. _installation_dependencies:
Dependencies
============
PySTAC requires Python >= 3.10. This project follows the recommendations of
`NEP-29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`__ in deprecating support
for Python versions. This means that users can expect support for Python 3.10 to be
removed from the ``main`` branch after Apr 04, 2025 and therefore from the next release
after that date.
As a foundational component of the Python STAC ecosystem used in a number of downstream
libraries, PySTAC aims to minimize its dependencies. As a result, the only dependency
for the basic PySTAC library is `python-dateutil
<https://dateutil.readthedocs.io/en/stable/>`__.
PySTAC also has the following extras, which can be optionally installed to provide
additional functionality:
* ``validation``
Installs the additional `jsonschema
<https://python-jsonschema.readthedocs.io/en/latest/>`__ dependency. When this
dependency is installed, the :ref:`validation methods <validation_concepts>` may be
used to validate STAC objects against the appropriate JSON schemas.
To install:
.. code-block:: bash
pip install pystac[validation]
* ``orjson``
Installs the additional `orjson <https://github.com/ijl/orjson>`__ dependency. When
this dependency is installed, `orjson` will be used as the default JSON
serialization/deserialization for all operations in PySTAC.
To install:
.. code-block:: bash
pip install pystac[orjson]
* ``urllib3``
Installs the additional `urllib3 <https://github.com/urllib3/urllib3>`__ dependency.
For now, this is only used in :py:class:`pystac.stac_io.RetryStacIO`, but it
may be used more extensively in the future.
To install:
.. code-block:: bash
pip install pystac[urllib3]
* ``jinja2``
Installs the additional `jinja2 <https://github.com/pallets/jinja>`__ dependency.
When this dependency is installed, jupyter notebooks display pretty representations
of PySTAC objects
To install:
.. code-block:: bash
pip install pystac[jinja2]
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.
.. list-table::
:widths: 50 50
:header-rows: 1
* - 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:
.. code-block:: bash
pip install pystac==0.4.0
STAC spec versions below 0.8 are not supported by PySTAC.
|
