Merge branch 'develop'

CS-SI · Aug 1, 2024 · 3592f7a · 3592f7a
2 parents 2ec9492 + 5065a00
commit 3592f7a
Show file tree

Hide file tree

Showing 120 changed files with 29,812 additions and 2,256 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -13,13 +13,13 @@ jobs:
 
     steps:
       - name: Checkout source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Get history and tags for SCM versioning to work
         run: |
           git fetch --prune --unshallow
           git fetch --depth=1 origin +refs/tags/*:refs/tags/*
       - name: Set up Python 3.8
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.8"
 

diff --git a/.github/workflows/fetch.yml b/.github/workflows/fetch.yml
@@ -3,7 +3,7 @@ name: Fetch product types
 on:
   workflow_dispatch:
   push:
-    branches: [master, develop]
+    branches: [develop]
   schedule:
     - cron: "0 6 * * *"
 
@@ -13,13 +13,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout the repo
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Get history and tags for SCM versioning to work
       run: |
         git fetch --prune --unshallow
         git fetch --depth=1 origin +refs/tags/*:refs/tags/*
     - name: Set up Python 3.8
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.8"
     - name: Update pip
@@ -33,7 +33,7 @@ jobs:
       shell: bash
       run: echo "WEEK=$(date +'%V')" >> $GITHUB_OUTPUT
     - name: Pip cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.pip-cache.outputs.DIR }}
         key: ${{ runner.os }}-pip-${{ steps.get-week.outputs.WEEK }}-${{ hashFiles('setup.cfg') }}
@@ -59,7 +59,7 @@ jobs:
         echo "commit [${COMMIT_SHA}](${COMMIT_URL})" >> $GITHUB_STEP_SUMMARY
         echo '```diff' >> $GITHUB_STEP_SUMMARY
         git show --name-only --format=tformat: >> $GITHUB_STEP_SUMMARY
-        (diff <(curl ${JSON_REF_FILE} | jq --sort-keys) <(cat ${JSON_OUTPUT_FILE} | jq --sort-keys) || true) >> $GITHUB_STEP_SUMMARY
+        (diff <(curl ${JSON_REF_FILE}) <(cat ${JSON_OUTPUT_FILE}) || true) >> $GITHUB_STEP_SUMMARY
         echo '```' >> $GITHUB_STEP_SUMMARY
         # truncated PR body (too long causes error)
         full_update_summary=$(cat $GITHUB_STEP_SUMMARY)

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -15,17 +15,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout the repo
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Get history and tags for SCM versioning to work
       run: |
         git fetch --prune --unshallow
         git fetch --depth=1 origin +refs/tags/*:refs/tags/*
     - name: Set up Python 3.8
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.8"
     - name: Run pre-commit action
-      uses: pre-commit/action@v3.0.0
+      uses: pre-commit/action@v3.0.1
 
   tests:
     name: Test it!
@@ -36,13 +36,13 @@ jobs:
         os: [ubuntu-latest, windows-latest]
     steps:
     - name: Checkout the repo
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Get history and tags for SCM versioning to work
       run: |
         git fetch --prune --unshallow
         git fetch --depth=1 origin +refs/tags/*:refs/tags/*
     - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Update pip
@@ -56,7 +56,7 @@ jobs:
       shell: bash
       run: echo "WEEK=$(date +'%V')" >> $GITHUB_OUTPUT
     - name: Pip cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.pip-cache.outputs.DIR }}
         key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ steps.get-week.outputs.WEEK }}-${{ hashFiles('setup.cfg') }}
@@ -156,13 +156,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout the repo
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Get history and tags for SCM versioning to work
       run: |
         git fetch --prune --unshallow
         git fetch --depth=1 origin +refs/tags/*:refs/tags/*
     - name: Set up Python 3.8
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.8"
     - name: Update pip
@@ -176,7 +176,7 @@ jobs:
       shell: bash
       run: echo "WEEK=$(date +'%V')" >> $GITHUB_OUTPUT
     - name: Pip cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.pip-cache.outputs.DIR }}
         key: ${{ runner.os }}-pip-${{ steps.get-week.outputs.WEEK }}-${{ hashFiles('setup.cfg') }}
@@ -195,13 +195,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout the repo
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Get history and tags for SCM versioning to work
       run: |
         git fetch --prune --unshallow
         git fetch --depth=1 origin +refs/tags/*:refs/tags/*
     - name: Set up Python 3.8
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.8"
     - name: Update pip
@@ -215,7 +215,7 @@ jobs:
       shell: bash
       run: echo "WEEK=$(date +'%V')" >> $GITHUB_OUTPUT
     - name: Pip cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.pip-cache.outputs.DIR }}
         key: ${{ runner.os }}-pip-${{ steps.get-week.outputs.WEEK }}-${{ hashFiles('setup.cfg') }}

diff --git a/BREAKING_CHANGES.rst b/BREAKING_CHANGES.rst
@@ -0,0 +1,58 @@
+Breaking changes
+----------------
+
+Full changelog available in `Release history <changelog.html>`_.
+
+3.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``.
+
+3.0.0b1
++++++++
+
+* :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.html#optional-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]"
+
+2.0b1
++++++
+
+- STAC API compliant REST server
+- Common configuration for STAC providers
+
+1.0
++++
+
+- Adds product type search functionality
+- The cli arguments are now fully compliant with opensearch geo(bbox)/time extensions
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,6 +1,50 @@
 Release history
 ---------------
 
+3.0.0b3 (2024-08-01)
+++++++++++++++++++++
+
+Breaking changes
+^^^^^^^^^^^^^^^^
+
+* :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`)
+
+Core features and fixes
+^^^^^^^^^^^^^^^^^^^^^^^
+
+* New :meth:`~eodag.api.core.EODataAccessGateway.add_provider` method (:pull:`1260`)
+* Handle integers as ``locations`` shapefile attributes (:pull:`1280`)
+* Renames some parameters and methods to snake_case (:pull:`1271`)
+* Sorted discovered product types (:pull:`1250`)
+
+Providers and product types updates
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* Fixes ``usgs`` search by id (:pull:`1262`)
+* Adds ``S1_SAR_GRD_COG`` and new odata query parameters for ``cop_dataspace`` (:pull:`1277`, thanks
+  `@ninsbl <https://github.com/ninsbl>`_)
+* Adds ``GRIDDED_GLACIERS_MASS_CHANGE`` on provider ``cop_cds`` (:pull:`1255`)
+* Removes ``cacheable`` parameter for ``wekeo`` order requests (:pull:`1239`)
+
+Plugins new features and fixes
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* ``aws_session_token`` support in :class:`~eodag.plugins.authentication.aws_auth.AwsAuth` (:pull:`1267`)
+* :class:`~eodag.plugins.download.http.HTTPDownload` asset ``HEAD`` check and ``ssl_verify`` (:pull:`1266`)
+* Product types discovery disabled by default on :class:`~eodag.plugins.search.static_stac_search.StaticStacSearch`
+  (:pull:`1259`)
+
+Miscellaneous
+^^^^^^^^^^^^^
+
+* **[style]** type hints fixes and ``mypy`` in ``tox`` (:pull:`1253`)(:pull:`1269`)
+* **[docs]** v3 breaking changes (:pull:`1281`), :meth:`~eodag.api.core.EODataAccessGateway.download` kwargs
+  (:pull:`1282`), autosummary fixes (:pull:`1264`) and changelog update (:pull:`1254`)
+* **[ci]** Github actions updates (:pull:`1249`)
+* **[test]** Fixed end-to-end tests (:pull:`1236`)
+* External product types reference updates (:pull:`1244`)(:pull:`1246`)(:pull:`1251`)
+
 3.0.0b2 (2024-06-29)
 ++++++++++++++++++++
 
@@ -41,6 +85,7 @@ Breaking changes
 Core features and fixes
 ^^^^^^^^^^^^^^^^^^^^^^^
 
+* Search results sort feature (:pull:`943`)
 * Providers groups (:pull:`1071`)
 * Configurable download timeout (:pull:`1124`)
 * `Search by id <https://eodag.readthedocs.io/en/stable/notebooks/api_user_guide/4_search.html#id-and-provider>`_ now
@@ -51,10 +96,11 @@ Core features and fixes
   <https://eodag.readthedocs.io/en/stable/notebooks/api_user_guide/6_crunch.html#Filter-by-property>`_ (:pull:`1070`),
   mission dates filtering support (:pull:`1222`)
 * Configurable requests ``ssl_verify`` (:pull:`1045`)
+* Download record hash independent from provider (:pull:`1023`)
 * Fixed and refactored `queryables` (:pull:`1050`)(:pull:`1097`)(:pull:`1102`)(:pull:`1157`), authentication fix
   (:pull:`1194`), support for local constraints files (:pull:`1105`)
 * Fixed `metadata mapping` in templates detection (:pull:`1139`), ``format_query_params()`` fixes (:pull:`1145`) and
-  refactor (:pull:`1142`)
+  refactor (:pull:`1142`). Configurable assets filtering (:pull:`1033`).
 
 Providers and product types updates
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -79,6 +125,7 @@ Providers and product types updates
 Plugins new features and fixes
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+* Standardized download output tree (:pull:`746`)
 * Refactored search plugins methods to use ``PreparedSearch`` and ``RawSearchResult`` new classes (:pull:`1191`)
 * Refresh token for :class:`~eodag.plugins.authentication.openid_connect.OIDCAuthorizationCodeFlowAuth` plugin
   (:pull:`1138`), tests (:pull:`1135`), and fix (:pull:`1232`)
@@ -89,10 +136,12 @@ Plugins new features and fixes
 * Allow no auth for :class:`~eodag.plugins.download.http.HTTPDownload` download requests (:pull:`1196`)
 * Refactorization of ``Api`` base plugin that now inherits from ``Search`` and ``Download`` (:pull:`1051`)
 * ``orderLink`` support in `build_search_result.*` plugins (:pull:`1082`), and parsing fix (:pull:`1091`)
+* Fixed resume interrupted assets download using :class:`~eodag.plugins.download.http.HTTPDownload` (:pull:`1017`)
 
 Server mode
 ^^^^^^^^^^^
 
+* Server-mode rework and cql2 support (:pull:`966`)
 * Offline products order handling (:pull:`918`)
 * External enhanced product types metadata (:pull:`1008`)(:pull:`1171`)(:pull:`1176`)(:pull:`1180`)(:pull:`1197`)
 * Collections search using updated :meth:`~eodag.api.core.EODataAccessGateway.guess_product_type` (:pull:`909`)
@@ -115,15 +164,15 @@ Miscellaneous
   (:pull:`1079`)
 * **[build]** Remove ``requests-ftp`` (:pull:`1085`)
 * **[style]** type hints related fixes and refactoring (:pull:`1052`)
-* **[docs]** sphinx theme updated and removed jquery (:pull:`1054`), newlines between badges fixes (:pull:`1109`), and other
-  documentation fixes and updates (:pull:`1057`)(:pull:`1059`)(:pull:`1062`)(:pull:`1063`)(:pull:`1081`)(:pull:`1121`)
-  (:pull:`1122`)
+* **[docs]** sphinx theme updated and removed jquery (:pull:`1054`), newlines between badges fixes (:pull:`1109`), and
+  other documentation fixes and updates (:pull:`1057`)(:pull:`1059`)(:pull:`1062`)(:pull:`1063`)(:pull:`1081`)
+  (:pull:`1121`)(:pull:`1122`)
 * **[ci]** Fetch product types Github action updates (:pull:`1202`)(:pull:`1205`)
 * Various minor fixes and improvements (:pull:`1072`)(:pull:`1077`)(:pull:`1101`)(:pull:`1111`)(:pull:`1118`)
   (:pull:`1132`)(:pull:`1141`)(:pull:`1190`)
-* External product types reference updates (:pull:`1086`)(:pull:`1093`)(:pull:`1107`)(:pull:`1110`)(:pull:`1114`)
-  (:pull:`1136`)(:pull:`1137`)(:pull:`1140`)(:pull:`1146`)(:pull:`1151`)(:pull:`1153`)(:pull:`1160`)(:pull:`1165`)
-  (:pull:`1203`)(:pull:`1204`)(:pull:`1206`)(:pull:`1207`)(:pull:`1208`)(:pull:`1229`)
+* External product types reference updates (:pull:`1027`)(:pull:`1028`)(:pull:`1086`)(:pull:`1093`)(:pull:`1107`)
+  (:pull:`1110`)(:pull:`1114`)(:pull:`1136`)(:pull:`1137`)(:pull:`1140`)(:pull:`1146`)(:pull:`1151`)(:pull:`1153`)
+  (:pull:`1160`)(:pull:`1165`)(:pull:`1203`)(:pull:`1204`)(:pull:`1206`)(:pull:`1207`)(:pull:`1208`)(:pull:`1229`)
 
 2.12.1 (2024-03-05)
 +++++++++++++++++++
@@ -277,7 +326,7 @@ Miscellaneous
 * `Product types catalog\
   <https://eodag.readthedocs.io/en/latest/getting_started_guide/product_types.html#product-types-information-csv>`_
   more visible in documentation (:pull:`603`)
-* Metadata mapping `to_geo_interface()` renammed to `to_geojson()`
+* Metadata mapping `to_geo_interface()` renamed to `to_geojson()`
   (`d7565a4 <https://github.com/CS-SI/eodag/pull/604/commits/d7565a4984d356aca20310a87c02692cb879427e>`_)
 * Added support for `python3.11` (:pull:`552`)
 * Improved http asset size discovery in :class:`~eodag.plugins.download.http.HTTPDownload` (:pull:`566`)

diff --git a/README.rst b/README.rst
@@ -23,8 +23,6 @@
 
 |pypi-badge| |conda-badge| |rtd-badge| |gha-badge| |ghi-badge| |binder-badge|
 
-|
-
 .. |license-badge| image:: https://img.shields.io/pypi/l/eodag.svg
     :target: https://pypi.org/project/eodag/
 
@@ -84,8 +82,14 @@ And with ``conda`` from the `conda-forge channel <https://anaconda.org/conda-for
 
    conda install -c conda-forge eodag
 
-**[New in v3.0.0]** Please note that EODAG comes with a minimal set of dependencies. If you want more features, please install using one of
-the `available extras <https://eodag.readthedocs.io/en/latest/getting_started_guide/install.html#optional-dependencies>`_.
+..
+
+  [!IMPORTANT]
+
+  `Breaking change <https://eodag.readthedocs.io/en/latest/breaking_changes.html>`_ **in v3.0.0**:
+  Please note that EODAG
+  comes with a minimal set of dependencies. If you want more features, please install using one of the
+  `available extras <https://eodag.readthedocs.io/en/latest/getting_started_guide/install.html#optional-dependencies>`_.
 
 Usage
 =====
@@ -119,8 +123,13 @@ This will search for Sentinel 2 level-1C products on the default provider and re
 an estimated total number of products matching the search criteria. And then it will download these products. Please
 check the `Python API User Guide <https://eodag.readthedocs.io/en/latest/api_user_guide.html>`_ for more details.
 
-**[New in v3.0.0]** `search() <https://eodag.readthedocs.io/en/latest/notebooks/api_user_guide/4_search.html#search()>`_
-method now returns only a single ``SearchResult`` instead of a 2 values tuple.
+..
+
+  [!IMPORTANT]
+
+  `Breaking change <https://eodag.readthedocs.io/en/latest/breaking_changes.html>`_ **in v3.0.0**:
+  `search() <https://eodag.readthedocs.io/en/latest/api_reference/core.html#eodag.api.core.EODataAccessGateway.search>`_ method now returns
+  only a single ``SearchResult`` instead of a 2 values tuple.
 
 STAC REST API
 -------------
@@ -183,7 +192,7 @@ An eodag instance can be exposed through a STAC compliant REST api from the comm
 
 .. code-block:: bash
 
-    docker run -p 5000:5000 --rm csspace/eodag-server:3.0.0b2
+    docker run -p 5000:5000 --rm csspace/eodag-server:3.0.0b3
 
 You can also browse over your STAC API server using `STAC Browser <https://github.com/radiantearth/stac-browser>`_.
 Simply run: