Eodag

-------------------

|:warning:| Breaking changes since last stable (`v2.12.1 <changelog.rstv2-12-1-2024-03-05>`_)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* [v3.0.0b1] `search() <https://eodag.readthedocs.io/en/latest/notebooks/api_user_guide/4_search.html#search()>`_ method
now returns only a :class:`~eodag.api.search_result.SearchResult` instead of a 2 values tuple (:pull:`1200`). It can
optionally store the estimated total number of products in ``SearchResult.number_matched`` if the method is called
with ``count=True`` (``False`` by default).
* [v3.0.0b1] Packaging refactoring and new `optional dependencies
<https://eodag.readthedocs.io/en/latest/getting_started_guide/install.html#optional-dependencies>`_ (:pull:`1108`)
(:pull:`1219`). EODAG default installs with a minimal set of dependencies.
New sets of extra requirements are: ``eodag[all]``, ``eodag[all-providers]``, ``eodag[ecmwf]``, ``eodag[usgs]``,
``eodag[csw]``, ``eodag[server]``. Previous existing sets of extra requirements are also kept:
``eodag[notebook]``, ``eodag[tutorials]``, ``eodag[dev]``, ``eodag[docs]``.
* [v3.0.0b3] :meth:`~eodag.api.core.EODataAccessGateway.download` / :class:`~eodag.types.download_args.DownloadConf`
parameters ``outputs_prefix`` and ``outputs_extension`` renamed to ``output_dir`` and ``output_extension``
(:pull:`1279`)

|:loudspeaker:| Major changes since last stable (`v2.12.1 <changelog.rstv2-12-1-2024-03-05>`_)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Core features and fixes
"""""""""""""""""""""""

* **[v3.0.0]** Sharable and multiple authentication plugins per provider (:pull:`1292`)(:pull:`1329`)(:pull:`1332`)
* [v3.0.0b3] New :meth:`~eodag.api.core.EODataAccessGateway.add_provider` method (:pull:`1260`)
* [v3.0.0b2] New :class:`~eodag.api.search_result.SearchResult` HTML representation for notebooks (:pull:`1243`)
* [v3.0.0b1] Search results sort feature (:pull:`943`)
* [v3.0.0b1] Providers groups (:pull:`1071`)
* [v3.0.0b1] Configurable download timeout (:pull:`1124`)

Providers and product types updates
"""""""""""""""""""""""""""""""""""

* **[v3.0.0]** Updated ``cop_ads`` and ``cop_cds`` to new cds api (:pull:`1284`)
* **[v3.0.0]** ``wekeo`` split into ``wekeo_main`` and ``wekeo_ecmwf`` providers (:pull:`1214`)
* [v3.0.0b1] `dedl <https://hda.data.destination-earth.eu/ui>`_ as new provider (:pull:`750`)
* [v3.0.0b1] `dedt_lumi <https://polytope.lumi.apps.dte.destination-earth.eu/openapi>`_ as new provider (:pull:`1119`)
(:pull:`1126`), with authentication using destine credentials (:pull:`1127`)
* [v3.0.0b1] `cop_marine <https://marine.copernicus.eu/>`_ as new provider (:pull:`1131`)(:pull:`1224`)
* [v3.0.0b1] `eumetsat_ds <https://data.eumetsat.int/>`_ as new provider (:pull:`1060`), including `METOP` product types
(:pull:`1143`)(:pull:`1189`)
* [v3.0.0b1] `OData` API usage for ``creodias`` & ``cop_dataspace`` (:pull:`1149`)

Plugins new features and fixes
""""""""""""""""""""""""""""""

* [v3.0.0b1] Standardized download output tree (:pull:`746`)
* [v3.0.0b1] ``flatten_top_dirs`` download plugins option set to true by default (:pull:`1220`)
* [v3.0.0b1] ``base_uri`` download plugins setting is not systematically mandatory any more (:pull:`1230`)
* [v3.0.0b1] Allow no auth for :class:`~eodag.plugins.download.http.HTTPDownload` download requests (:pull:`1196`)

Server mode
"""""""""""

* [v3.0.0b1] Server-mode rework and cql2 support (:pull:`966`)
* [v3.0.0b1] Offline products order handling (:pull:`918`)
* **[v3.0.0]** Browsable catalogs removed (:pull:`1306`)

Miscellaneous
"""""""""""""

* **[v3.0.0b1 to v3.0.0][style]** type hints fixes and ``mypy`` in ``tox`` (:pull:`1052`)(:pull:`1253`)(:pull:`1269`)
(:pull:`1326`)
* **[v3.0.0][docs]** Developer documentation update (:pull:`1327`)

Remaining changes since `v3.0.0b3 <changelog.rstv3-0-0b3-2024-08-01>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Core features and fixes
"""""""""""""""""""""""

* Improve search and authentication errors format (:pull:`1237`)

Providers and product types updates
"""""""""""""""""""""""""""""""""""

* Handle ``cop_marine`` in-situ historical data (:pull:`1301`)
* Fixes for ``wekeo``: ``GRIDDED_GLACIERS_MASS_CHANGE`` order link (:pull:`1258`), yaml issue in provider config
(:pull:`1315`)
* Fixes for ``wekeo_ecmwf``: ``hydrological_year`` usage (:pull:`1313`), fixed default dates (:pull:`1288`)

Plugins new features and fixes
""""""""""""""""""""""""""""""

* Raise an error if no data available on :class:`~eodag.plugins.download.aws.AwsDownload` (:pull:`1257`)

Server mode
"""""""""""

* Fixed *queryables* issues and parameters prefixes (:pull:`1318`)
* Send ``search_stac_items()`` in its own threadpool (:pull:`1323`)
* Fixed STAC collections metadata (:pull:`1278`)
* Updated logs format (:pull:`1238`)

Miscellaneous
"""""""""""""

* **[ci]** ``mypy`` in linting github action (:pull:`1326`), actions updates (:pull:`1310`)(:pull:`1314`)
* Various minor fixes and improvements (:pull:`1256`)(:pull:`1263`)(:pull:`1276`)(:pull:`1289`)(:pull:`1294`)
(:pull:`1295`)(:pull:`1296`)(:pull:`1300`)(:pull:`1303`)(:pull:`1304`)(:pull:`1308`)(:pull:`1333`)
* External product types reference updates (:pull:`1290`)(:pull:`1316`)(:pull:`1322`)(:pull:`1334`)

+++++++

* :meth:`~eodag.api.core.EODataAccessGateway.download` / :class:`~eodag.types.download_args.DownloadConf` parameters
``outputs_prefix`` and ``outputs_extension`` renamed to ``output_dir`` and ``output_extension``.

---------------------

Core features and fixes
^^^^^^^^^^^^^^^^^^^^^^^

* New :class:`~eodag.api.search_result.SearchResult` HTML representation for notebooks (:pull:`1243`)

Plugins new features and fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Fixed missing ``products`` configuration in ``Api`` plugin download (:pull:`1241`)
* Fixed ``pagination`` configuration to be not allways mandatory (:pull:`1240`)

Miscellaneous
^^^^^^^^^^^^^

* **[docs]** Custom mock search plugin example (:pull:`1242`)
* External product types reference updates (:pull:`1234`)

+++++++

* :meth:`~eodag.api.core.EODataAccessGateway.search` method now returns only a
:class:`~eodag.api.search_result.SearchResult` instead of a 2 values tuple. It can optionally store the estimated
total number of products in ``SearchResult.number_matched`` if the method is called with ``count=True``
(``False`` by default).

* **eodag < 3.0.0b1 syntax:**

.. code-block:: python

search_results, number_matched = dag.search(productType="S2_MSI_L1C")

| Traceback (most recent call last):
| File "<stdin>", line 1, in <module>
| ValueError: too many values to unpack (expected 2)

* **eodag >= 3.0.0b1 syntax:**

.. code-block:: python

search_results = dag.search(productType="S2_MSI_L1C")

* Packaging refactoring and new `optional dependencies
<getting_started_guide/install.htmloptional-dependencies>`_. EODAG default
installs with a minimal set of dependencies.
New sets of extra requirements are: ``eodag[all]``, ``eodag[all-providers]``, ``eodag[ecmwf]``, ``eodag[usgs]``,
``eodag[csw]``, ``eodag[server]``, ``eodag[stubs]``. Previous existing sets of extra requirements are also kept:
``eodag[notebook]``, ``eodag[tutorials]``, ``eodag[dev]``, ``eodag[docs]``.

.. code-block:: sh

install eodag with all available providers supported
pip install "eodag[all-providers]"

--------------------

* `CdsApi` queryables fix (:pull:`1048`)

--------------------

* Individual product asset download methods (:pull:`932`)
* New environment variable `EODAG_CFG_DIR` available for custom configuration directory (:pull:`927`)
* New `list_queryables <https://eodag.readthedocs.io/en/latest/notebooks/api_user_guide/4_search.html#Queryables>`_
method, available through python API and server mode, and using product-types constraints if available (:pull:`911`)
(:pull:`917`)(:pull:`974`)(:pull:`977`)(:pull:`978`)(:pull:`981`)(:pull:`1005`)
* Removes limited RPC server (:pull:`1011`)
* Product types aliases (:pull:`905`)
* New provider `creodias_s3` (:pull:`986`)(:pull:`1002`)
* `earth_search` endpoint updated from v0 to v1 (:pull:`754`)
* `wekeo` endpoint updated to *wekeo2 wekeo-broker API* (:pull:`1010`)
* New product types added for `cop_ads` and `cop_cds` (:pull:`898`)
* Adds missing `tileIdentifier` and `quicklook` for `creodias`, `creodias_s3` and `cop_dataspace` (:pull:`957`)
(:pull:`1014`)
* HTTP download with `CdsApi` (:pull:`946`)
* Download streaming available for :class:`~eodag.plugins.download.aws.AwsDownload` plugin (:pull:`997`)
* Lists STAC alternate assets in server mode (:pull:`961`)
* `_dc_qs` used in server-mode to store `CdsApi` search criteria (:pull:`958`)(:pull:`1000`)
* New eodag exception :class:`~eodag.utils.exceptions.TimeOutError` (:pull:`982`)
* Cast loaded environment variables type using config type-hints (:pull:`987`)
* Type hints fixes (:pull:`880`)(:pull:`983`)
* Requirements updates (:pull:`1020`)(:pull:`1021`)
* Various server mode fixes (:pull:`891`)(:pull:`895`)(:pull:`947`)(:pull:`992`)(:pull:`1001`)
* Various minor fixes and improvements (:pull:`934`)(:pull:`935`)(:pull:`936`)(:pull:`962`)(:pull:`969`)(:pull:`976`)
(:pull:`980`)(:pull:`988`)(:pull:`991`)(:pull:`996`)(:pull:`1003`)(:pull:`1009`)(:pull:`1013`)(:pull:`1016`)
(:pull:`1019`)(:pull:`1022`)(:pull:`1024`)(:pull:`1025`)