File: index.rst

package info (click to toggle)
pystac-client 0.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 47,416 kB
  • sloc: python: 4,652; sh: 74; makefile: 60
file content (65 lines) | stat: -rw-r--r-- 2,372 bytes parent folder | download
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
PySTAC Client Documentation
===========================

PySTAC Client is a Python package for working with `STAC <https://github.com/radiantearth/stac-spec>`__
Catalogs and `STAC APIs <https://github.com/radiantearth/stac-api-spec>`__.
PySTAC Client builds upon PySTAC through higher-level functionality and ability to
access STAC API search endpoints.

STAC Versions
=============

+---------------+---------------+-----------------------------+
| pystac-client |   STAC spec   |        STAC API Spec        |
+===============+===============+=============================+
| 0.9.x         | 1.0.x - 1.1.x | 1.0.0-beta.1 - 1.0.0        |
+---------------+---------------+-----------------------------+
| 0.8.x         | 1.0.x         | 1.0.0-beta.1 - 1.0.0        |
+---------------+---------------+-----------------------------+
| 0.7.x         | 1.0.x         | 1.0.0-beta.1 - 1.0.0        |
+---------------+---------------+-----------------------------+
| 0.6.x         | 1.0.x         | 1.0.0-beta.1 - 1.0.0-rc.2   |
+---------------+---------------+-----------------------------+
| 0.5.x         | 1.0.x         | 1.0.0-beta.1 - 1.0.0-rc.1   |
+---------------+---------------+-----------------------------+
| 0.4.x         | 1.0.x         | 1.0.0-beta.1 - 1.0.0-rc.1   |
+---------------+---------------+-----------------------------+
| 0.3.x         | 1.0.x         | 1.0.0-beta.1 - 1.0.0-beta.4 |
+---------------+---------------+-----------------------------+
| 0.2.x         | 1.0.x         | 1.0.0-beta.1 - 1.0.0-beta.2 |
+---------------+---------------+-----------------------------+

Installation
------------

``pystac-client`` requires `Python >=3.10 <https://www.python.org/>`__.

To install with pip, run:

.. code-block:: console

   $ python -m pip install pystac-client

This will install the dependencies :doc:`pystac <pystac:index>`,
:doc:`python-dateutil <dateutil:index>`, and :doc:`requests <requests:index>`.

Acknowledgements
----------------

This package builds upon the great work of the PySTAC library for working with
STAC objects in Python. It also uses concepts from the
`sat-search <https://github.com/sat-utils/sat-search>`__ library for working with STAC
API search endpoints.

Table of Contents
-----------------

.. toctree::
   :maxdepth: 2

   quickstart
   usage
   api
   tutorials
   contributing
   design/design_decisions