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
|
.. module:: eodag.utils
:no-index:
=====
Utils
=====
This section provides an overview of the utility functions and classes available in the `eodag` library.
These utilities are designed to assist with various tasks such as logging, handling callbacks, performing free text searches, working with Jupyter notebooks, interacting with S3 storage, and processing xarray data.
Each subsection below details the specific utilities and their usage.
Logging
-------
.. automodule:: eodag.utils.logging
:members:
Callbacks
---------
.. autoclass:: eodag.utils.DownloadedCallback
:special-members: __call__
.. autofunction:: eodag.utils.ProgressCallback
Dates
-----
.. automodule:: eodag.utils.dates
:members:
Free text search
----------------
.. autofunction:: eodag.utils.free_text_search.compile_free_text_query
Notebook
--------
.. automodule:: eodag.utils.notebook
:members:
S3
----
.. automodule:: eodag.utils.s3
:members:
xarray
------
.. warning::
These functions will only be available with `eodag-cube <https://github.com/CS-SI/eodag-cube>`__ installed.
.. automodule:: eodag_cube.utils.xarray
:members:
Misc
----
.. automodule:: eodag.utils
:members:
:exclude-members: DownloadedCallback, ProgressCallback, NotebookProgressCallback, get_progress_callback,
DEFAULT_PROJ, GENERIC_COLLECTION, GENERIC_STAC_PROVIDER, STAC_SEARCH_PLUGINS, USER_AGENT,
HTTP_REQ_TIMEOUT, DEFAULT_SEARCH_TIMEOUT, DEFAULT_STREAM_REQUESTS_TIMEOUT, REQ_RETRY_TOTAL,
REQ_RETRY_BACKOFF_FACTOR, REQ_RETRY_STATUS_FORCELIST, DEFAULT_DOWNLOAD_WAIT, DEFAULT_DOWNLOAD_TIMEOUT,
JSONPATH_MATCH, WORKABLE_JSONPATH_MATCH, ARRAY_FIELD_MATCH, DEFAULT_PAGE, DEFAULT_LIMIT,
DEFAULT_MAX_LIMIT, DEFAULT_MISSION_START_DATE, DEFAULT_SHAPELY_GEOMETRY,
DEFAULT_TOKEN_EXPIRATION_MARGIN, KNOWN_NEXT_PAGE_TOKEN_KEYS, ONLINE_STATUS, STAC_VERSION
Constants: Core
---------------
.. autodata:: eodag.utils.GENERIC_COLLECTION
.. autodata:: eodag.utils.GENERIC_STAC_PROVIDER
.. autodata:: eodag.utils.STAC_SEARCH_PLUGINS
.. autodata:: eodag.utils.STAC_VERSION
Constants: HTTP requests
------------------------
.. autodata:: eodag.utils.USER_AGENT
.. autodata:: eodag.utils.HTTP_REQ_TIMEOUT
.. autodata:: eodag.utils.DEFAULT_SEARCH_TIMEOUT
.. autodata:: eodag.utils.DEFAULT_STREAM_REQUESTS_TIMEOUT
.. autodata:: eodag.utils.REQ_RETRY_TOTAL
.. autodata:: eodag.utils.REQ_RETRY_BACKOFF_FACTOR
.. autodata:: eodag.utils.REQ_RETRY_STATUS_FORCELIST
.. autodata:: eodag.utils.DEFAULT_DOWNLOAD_WAIT
.. autodata:: eodag.utils.DEFAULT_DOWNLOAD_TIMEOUT
.. autodata:: eodag.utils.DEFAULT_TOKEN_EXPIRATION_MARGIN
Constants: Pagination
---------------------
.. autodata:: eodag.utils.DEFAULT_PAGE
.. autodata:: eodag.utils.DEFAULT_LIMIT
.. autodata:: eodag.utils.DEFAULT_MAX_LIMIT
.. autodata:: eodag.utils.KNOWN_NEXT_PAGE_TOKEN_KEYS
Constants: Metadata-mapping / default values
--------------------------------------------
.. autodata:: eodag.utils.DEFAULT_PROJ
.. autodata:: eodag.utils.DEFAULT_MISSION_START_DATE
.. autodata:: eodag.utils.DEFAULT_SHAPELY_GEOMETRY
.. autodata:: eodag.utils.ONLINE_STATUS
Constants: Metadata-mapping / JSONPath regex
--------------------------------------------
.. autodata:: eodag.utils.JSONPATH_MATCH
.. autodata:: eodag.utils.WORKABLE_JSONPATH_MATCH
.. autodata:: eodag.utils.ARRAY_FIELD_MATCH
|
