eodag 2.12.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

eodag/resources/user_conf_template.yml

@@ -20,7 +20,7 @@ peps:
     search:  # Search parameters configuration
     download:
         extract:  # whether to extract the downloaded products, only applies to archived products (true or false, Default: true).
-        outputs_prefix: # where to store downloaded products, as an absolute file path (Default: local temporary directory)
+        output_dir: # where to store downloaded products, as an absolute file path (Default: local temporary directory)
         dl_url_params:  # additional parameters to pass over to the download url as an url parameter
         delete_archive: # whether to delete the downloaded archives (true or false, Default: true).
     auth:
@@ -32,7 +32,7 @@ theia:
     search:   # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
         dl_url_params:
     auth:
         credentials:
@@ -42,7 +42,7 @@ usgs:
     priority: # Lower value means lower priority (Default: 0)
     api:
         extract:
-        outputs_prefix:
+        output_dir:
         dl_url_params:
         product_location_scheme:
         credentials:
@@ -51,20 +51,22 @@ usgs:
 aws_eos:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
-    auth:
+    search_auth:
+        credentials:
+            api_key:
+    download_auth:
         credentials:
-            apikey:
             aws_access_key_id:
             aws_secret_access_key:
             aws_profile:
     download:
-        outputs_prefix:
+        output_dir:
 creodias:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
@@ -75,7 +77,7 @@ onda:
     search:   # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
@@ -89,7 +91,7 @@ astraea_eod:
             aws_secret_access_key:
             aws_profile:
     download:
-        outputs_prefix:
+        output_dir:
 usgs_satapi_aws:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
@@ -99,7 +101,7 @@ usgs_satapi_aws:
             aws_secret_access_key:
             aws_profile:
     download:
-        outputs_prefix:
+        output_dir:
 earth_search:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
@@ -109,12 +111,12 @@ earth_search:
             aws_secret_access_key:
             aws_profile:
     download:
-        outputs_prefix:
+        output_dir:
 earth_search_cog:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
     download:
-        outputs_prefix:
+        output_dir:
 earth_search_gcs:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
@@ -123,34 +125,38 @@ earth_search_gcs:
             aws_access_key_id:
             aws_secret_access_key:
     download:
-        outputs_prefix:
+        output_dir:
 ecmwf:
     priority: # Lower value means lower priority (Default: 0)
     api:
-        outputs_prefix:
+        output_dir:
         credentials:
             username:
             password:
 cop_ads:
     priority: # Lower value means lower priority (Default: 0)
-    api:
-        outputs_prefix:
-        credentials:
-            username:
-            password:
+    search:   # Search parameters configuration
+    download:
+        extract:
+        output_dir:
+    auth:
+      credentials:
+        apikey:
 cop_cds:
     priority: # Lower value means lower priority (Default: 0)
-    api:
-        outputs_prefix:
+    search:   # Search parameters configuration
+    download:
+        extract:
+        output_dir:
+    auth:
         credentials:
-            username:
-            password:
+            apikey:
 sara:
     priority: # Lower value means lower priority (Default: 0)
     search:  # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
         delete_archive:
     auth:
         credentials:
@@ -163,13 +169,13 @@ meteoblue:
         credentials:
             apikey:
     download:
-        outputs_prefix:
+        output_dir:
 cop_dataspace:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
@@ -181,7 +187,7 @@ planetary_computer:
         credentials:
             apikey:
     download:
-        outputs_prefix:
+        output_dir:
 hydroweb_next:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
@@ -189,23 +195,74 @@ hydroweb_next:
         credentials:
             apikey:
     download:
-        outputs_prefix:
-wekeo:
+        output_dir:
+wekeo_main:
+    priority: # Lower value means lower priority (Default: 0)
+    search:   # Search parameters configuration
+    download:
+        output_dir:
+    auth:
+        credentials:
+            username:
+            password:
+wekeo_ecmwf:
+    priority: # Lower value means lower priority (Default: 0)
+    search:   # Search parameters configuration
+    download:
+        output_dir:
+    auth:
+        credentials:
+            username:
+            password:
+wekeo_cmems:
     priority: # Lower value means lower priority (Default: 0)
     search:
     download:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
             password:
-
 creodias_s3:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
     download:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
           aws_access_key_id:
           aws_secret_access_key:
+dedt_lumi:
+    priority: # Lower value means lower priority (Default: 0)
+    search:
+    download:
+        output_dir:
+    auth:
+        credentials:
+            username:
+            password:
+dedl:
+    priority: # Lower value means lower priority (Default: 0)
+    search:   # Search parameters configuration
+    download:
+        output_dir:
+    auth:
+      credentials:
+        username:
+        password:
+eumetsat_ds:
+    priority: # Lower value means lower priority (Default: 0)
+    search:   # Search parameters configuration
+        output_dir:
+    auth:
+        credentials:
+            username:
+            password:
+    download:
+        output_dir:
+cop_marine:
+    priority: # Lower value means lower priority (Default: 0)
+    search:   # Search parameters configuration
+    download:
+        extract:
+        output_dir:

eodag/rest/__init__.py

@@ -16,3 +16,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """EODAG REST API"""
+try:
+    from fastapi import __version__  # noqa: F401
+except ImportError:
+    raise ImportError(
+        f"{__name__} not available, please install eodag[server] or eodag[all]"
+    )

eodag/rest/cache.py

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024, CS GROUP - France, https://www.csgroup.eu/
+#
+# This file is part of EODAG project
+#     https://www.github.com/CS-SI/EODAG
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import logging
+from typing import Any, Callable, Coroutine, Dict, TypeVar, cast
+
+import orjson
+from cachetools import LRUCache
+from fastapi import FastAPI, Request
+
+from eodag.rest.config import Settings
+from eodag.utils import urlsplit
+
+logger = logging.getLogger("eodag.rest.utils")
+
+T = TypeVar("T")
+
+
+def init_cache(app: FastAPI) -> None:
+    """Connect to local cache"""
+    settings = Settings.from_environment()
+
+    app.state.cache = LRUCache(maxsize=settings.cache_maxsize)
+
+
+async def cached(
+    fn: Callable[[], Coroutine[Any, Any, T]], cache_key: str, request: Request
+) -> T:
+    """Either get the result from local cache or run the function and cache the result."""
+    settings = Settings.from_environment()
+
+    host = urlsplit(cast(str, request.state.url_root)).netloc
+
+    host_cache_key = f"{cache_key}:{host}"
+
+    try:
+        c: Dict[str, Any] = request.app.state.cache
+
+        if cached := c.get(host_cache_key):
+            logger.debug("Cache result hit")
+            return orjson.loads(cached)  # type: ignore
+    except Exception as e:
+        logger.error(f"Error in cache: {e}")
+        if settings.debug:
+            raise
+
+    result = await fn()
+
+    try:
+        c[host_cache_key] = orjson.dumps(result)  # type: ignore
+    except Exception as e:
+        logger.error(f"Error in cache: {e}")
+        if settings.debug:
+            raise
+
+    return result

eodag/rest/config.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024, CS GROUP - France, https://www.csgroup.eu/
+#
+# This file is part of EODAG project
+#     https://www.github.com/CS-SI/EODAG
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+from functools import lru_cache
+from typing import List, Union
+
+from pydantic import Field
+from pydantic.functional_validators import BeforeValidator
+from pydantic_settings import BaseSettings, SettingsConfigDict
+from typing_extensions import Doc
+
+from eodag.rest.constants import DEFAULT_MAXSIZE, DEFAULT_TTL
+from eodag.utils import Annotated
+
+
+def str2liststr(raw: Union[str, List[str]]) -> List[str]:
+    """Convert str to list[str]"""
+    if isinstance(raw, list):
+        return raw
+    return raw.split(",")
+
+
+class Settings(BaseSettings):
+    """EODAG Server config"""
+
+    # local cache config
+    cache_ttl: int = Field(default=DEFAULT_TTL)
+    cache_maxsize: int = Field(default=DEFAULT_MAXSIZE)
+
+    debug: bool = False
+
+    stac_api_title: str = "eodag-stac-api"
+    stac_api_description: str = "STAC API provided by EODAG"
+    stac_api_landing_id: str = "eodag-stac-api"
+
+    origin_url_blacklist: Annotated[
+        Union[str, List[str]],
+        BeforeValidator(str2liststr),
+        Doc(
+            "Hide from clients items assets' alternative URLs starting with URLs from the list"
+        ),
+    ] = Field(default=[])
+
+    model_config = SettingsConfigDict(
+        env_prefix="EODAG_", extra="ignore", env_nested_delimiter="__"
+    )
+
+    @classmethod
+    @lru_cache(maxsize=1)
+    def from_environment(cls) -> Settings:
+        """Get settings"""
+        return Settings()

eodag/rest/constants.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024, CS GROUP - France, https://www.csgroup.eu/
+#
+# This file is part of EODAG project
+#     https://www.github.com/CS-SI/EODAG
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# default cache ttl
+DEFAULT_TTL = 600  # 10 min
+
+DEFAULT_MAXSIZE = 2048  # local cache maxsize
+
+CACHE_KEY_COLLECTIONS = "collections"
+CACHE_KEY_COLLECTION = "collection"
+CACHE_KEY_SEARCH = "search"
+CACHE_KEY_QUERYABLES = "queryables"