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
|
API Reference
=============
This section is autogenerated from in-line code documentation. It is mostly useful as a
reference for the various classes, methods, and other objects in the library, but is
not intended to function as a starting point for working with ``pystac_client``.
Client
------
Client is the base PySTAC-Client that inherits from :class:`Catalog <pystac.Catalog>`.
In addition to the PySTAC functionality, Client allows opening of API URLs,
understanding of conformance, and support for searching and paging through results.
.. autoclass:: pystac_client.Client
:members:
:undoc-members:
:show-inheritance:
Collection Client
-----------------
Client is the a PySTAC-Client that inherits from
:class:`Collection <pystac.Collection>`. In addition to the PySTAC functionality,
CollectionClient allows opening of API URLs, and iterating through items at a search
endpoint, if supported.
.. autoclass:: pystac_client.CollectionClient
:members:
:undoc-members:
Collection Search
-----------------
The `CollectionSearch` class represents a search of collections in a STAC API.
.. autoclass:: pystac_client.CollectionSearch
:members:
:undoc-members:
:member-order: bysource
Item Search
-----------
The `ItemSearch` class represents a search of a STAC API.
.. autoclass:: pystac_client.ItemSearch
:members:
:undoc-members:
:member-order: bysource
STAC API IO
-----------
The StacApiIO class inherits from the :class:`Collection <pystac.DefaultStacIO>`
class and allows for reading over http, such as with REST APIs.
.. autoclass:: pystac_client.stac_api_io.StacApiIO
:members:
:undoc-members:
:show-inheritance:
Conformance
-----------
.. automodule:: pystac_client.conformance
:members:
:undoc-members:
:show-inheritance:
Exceptions
----------
.. automodule:: pystac_client.exceptions
:members:
:undoc-members:
:show-inheritance:
Warnings
--------
.. automodule:: pystac_client.warnings
:members:
:undoc-members:
:show-inheritance:
|
