eodash_catalog 0.0.17__tar.gz → 0.0.19__tar.gz

{eodash_catalog-0.0.17 → eodash_catalog-0.0.19}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.17
+current_version = 0.0.19
 commit = True
 tag = True
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+)\.(?P<build>\d+))?

{eodash_catalog-0.0.17 → eodash_catalog-0.0.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: eodash_catalog
-Version: 0.0.17
+Version: 0.0.19
 Summary: This package is intended to help create a compatible STAC catalog for the eodash dashboard client. It supports configuration of multiple endpoint types for information extraction.
 Project-URL: Documentation, https://github.com/eodash/eodash_catalog#readme
 Project-URL: Issues, https://github.com/eodash/eodash_catalog/issues

{eodash_catalog-0.0.17 → eodash_catalog-0.0.19}/src/eodash_catalog/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2024-present Daniel Santillan <daniel.santillan@eox.at>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.0.17"
+__version__ = "0.0.19"

{eodash_catalog-0.0.17 → eodash_catalog-0.0.19}/src/eodash_catalog/endpoints.py

@@ -136,6 +136,8 @@ def handle_STAC_based_endpoint(
             link.extra_fields["latlng"] = latlng
             link.extra_fields["name"] = location["Name"]
             add_example_info(collection, collection_config, endpoint_config, catalog_config)
+            # eodash v4 compatibility
+            add_visualization_info(collection, collection_config, endpoint_config)
             if "OverwriteBBox" in location:
                 collection.extent.spatial = SpatialExtent(
                     [
@@ -160,7 +162,8 @@ def handle_STAC_based_endpoint(
             headers=headers,
             bbox=bbox,
         )
-
+    # eodash v4 compatibility
+    add_visualization_info(root_collection, collection_config, endpoint_config)
     add_example_info(root_collection, collection_config, endpoint_config, catalog_config)
     return root_collection
 
@@ -306,6 +309,8 @@ def handle_collection_only(
             link = collection.add_item(item)
             link.extra_fields["datetime"] = t
     add_collection_information(catalog_config, collection, collection_config)
+    # eodash v4 compatibility
+    add_visualization_info(collection, collection_config, endpoint_config)
     return collection
 
 
@@ -359,6 +364,8 @@ def handle_SH_WMS_endpoint(
         for c_child in root_collection.get_children():
             if isinstance(c_child, Collection):
                 root_collection.extent.spatial.bboxes.append(c_child.extent.spatial.bboxes[0])
+    # eodash v4 compatibility
+    add_visualization_info(root_collection, collection_config, endpoint_config)
     return root_collection
 
 
@@ -512,7 +519,10 @@ def handle_WMS_endpoint(
         )
     # optionally filter time results
     if query := endpoint_config.get("Query"):
-        datetime_query = [times[0], times[-1]]
+        datetime_query = [
+            parser.isoparse(times[0]).replace(tzinfo=timezone.utc),
+            parser.isoparse(times[-1]).replace(tzinfo=timezone.utc),
+        ]
         if start := query.get("Start"):
             datetime_query[0] = parser.isoparse(start).replace(tzinfo=timezone.utc)
         if end := query.get("End"):
@@ -549,6 +559,8 @@ def handle_WMS_endpoint(
                 endpoint_config["OverwriteBBox"],
             ]
         )
+    # eodash v4 compatibility
+    add_visualization_info(collection, collection_config, endpoint_config)
     add_collection_information(catalog_config, collection, collection_config)
     return collection
 
@@ -576,6 +588,9 @@ def add_visualization_info(
     file_url: str | None = None,
     time: str | None = None,
 ) -> None:
+    extra_fields: dict[str, list[str] | dict[str, str]] = {}
+    if "Attribution" in endpoint_config:
+        extra_fields["attribution"] = endpoint_config["Attribution"]
     # add extension reference
     if endpoint_config["Name"] == "Sentinel Hub" or endpoint_config["Name"] == "Sentinel Hub WMS":
         instanceId = os.getenv("SH_INSTANCE_ID")
@@ -585,10 +600,12 @@ def add_visualization_info(
             # special handling for custom environment
             # (will take SH_INSTANCE_ID_{env_id}) as ENV VAR
             instanceId = os.getenv(f"SH_INSTANCE_ID_{env_id}")
-        extra_fields: dict[str, list[str] | dict[str, str]] = {
-            "wms:layers": [endpoint_config["LayerId"]],
-            "role": ["data"],
-        }
+        extra_fields.update(
+            {
+                "wms:layers": [endpoint_config["LayerId"]],
+                "role": ["data"],
+            }
+        )
         if time is not None:
             if endpoint_config["Name"] == "Sentinel Hub WMS":
                 # SH WMS for public collections needs time interval, we use full day here
@@ -609,19 +626,19 @@ def add_visualization_info(
             )
         )
     elif endpoint_config["Name"] == "WMS":
-        extra_fields = {
-            "wms:layers": [endpoint_config["LayerId"]],
-            "role": ["data"],
-        }
+        extra_fields.update(
+            {
+                "wms:layers": [endpoint_config["LayerId"]],
+                "role": ["data"],
+            }
+        )
         if time is not None:
             extra_fields["wms:dimensions"] = {
                 "TIME": time,
             }
         if "Styles" in endpoint_config:
             extra_fields["wms:styles"] = endpoint_config["Styles"]
-        media_type = "image/jpeg"
-        if "MediaType" in endpoint_config:
-            media_type = endpoint_config["MediaType"]
+        media_type = endpoint_config.get("MediaType", "image/jpeg")
         endpoint_url = endpoint_config["EndPoint"]
         # custom replacing of all ENV VARS present as template in URL as {VAR}
         endpoint_url = replace_with_env_variables(endpoint_url)
@@ -637,9 +654,9 @@ def add_visualization_info(
     elif endpoint_config["Name"] == "JAXA_WMTS_PALSAR":
         target_url = "{}".format(endpoint_config.get("EndPoint"))
         # custom time just for this special case as a default for collection wmts
-        extra_fields = {
-            "wmts:layer": endpoint_config.get("LayerId", "").replace("{time}", time or "2017")
-        }
+        extra_fields.update(
+            {"wmts:layer": endpoint_config.get("LayerId", "").replace("{time}", time or "2017")}
+        )
         stac_object.add_link(
             Link(
                 rel="wmts",
@@ -680,14 +697,17 @@ def add_visualization_info(
                     target=target_url,
                     media_type="image/png",
                     title="xcube tiles",
+                    extra_fields=extra_fields,
                 )
             )
-    elif endpoint_config["Type"] == "WMTSCapabilities":
+    elif endpoint_config.get("Type") == "WMTSCapabilities":
         target_url = "{}".format(endpoint_config.get("EndPoint"))
-        extra_fields = {
-            "wmts:layer": endpoint_config.get("LayerId", ""),
-            "role": ["data"],
-        }
+        extra_fields.update(
+            {
+                "wmts:layer": endpoint_config.get("LayerId", ""),
+                "role": ["data"],
+            }
+        )
         dimensions = {}
         if time is not None:
             dimensions["time"] = time
@@ -717,6 +737,7 @@ def add_visualization_info(
                     target=target_url,
                     media_type="image/png",
                     title=collection_config["Name"],
+                    extra_fields=extra_fields,
                 )
             )
     elif endpoint_config["Name"] == "GeoDB Vector Tiles":
@@ -728,20 +749,23 @@ def add_visualization_info(
             endpoint_config["Database"],
             endpoint_config["CollectionId"],
         )
+        extra_fields.update(
+            {
+                "description": collection_config["Title"],
+                "parameters": endpoint_config["Parameters"],
+                "matchKey": endpoint_config["MatchKey"],
+                "timeKey": endpoint_config["TimeKey"],
+                "source": endpoint_config["Source"],
+                "role": ["data"],
+            }
+        )
         stac_object.add_link(
             Link(
                 rel="xyz",
                 target=target_url,
                 media_type="application/pbf",
                 title=collection_config["Name"],
-                extra_fields={
-                    "description": collection_config["Title"],
-                    "parameters": endpoint_config["Parameters"],
-                    "matchKey": endpoint_config["MatchKey"],
-                    "timeKey": endpoint_config["TimeKey"],
-                    "source": endpoint_config["Source"],
-                    "role": ["data"],
-                },
+                extra_fields=extra_fields,
             )
         )
     else:

{eodash_catalog-0.0.17 → eodash_catalog-0.0.19}/src/eodash_catalog/generate_indicators.py

@@ -88,6 +88,8 @@ def process_catalog_file(file_path: str, options: Options):
                     )
                 else:
                     print(f"Warning: neither collection nor indicator found for {collection}")
+        if "MapProjection" in catalog_config:
+            catalog.extra_fields["eodash:mapProjection"] = catalog_config["MapProjection"]
 
         strategy = TemplateLayoutStrategy(item_template="${collection}/${year}")
         # expecting that the catalog will be hosted online, self url should correspond to that
@@ -196,64 +198,64 @@ def process_collection_file(
     with open(file_path) as f:
         collection_config: dict = yaml.load(f, Loader=SafeLoader)
         if "Resources" in collection_config:
-            for resource in collection_config["Resources"]:
+            for endpoint_config in collection_config["Resources"]:
                 collection = None
-                if resource["Name"] == "Sentinel Hub":
+                if endpoint_config["Name"] == "Sentinel Hub":
                     collection = handle_SH_endpoint(
-                        catalog_config, resource, collection_config, catalog, options
+                        catalog_config, endpoint_config, collection_config, catalog, options
                     )
-                elif resource["Name"] == "Sentinel Hub WMS":
+                elif endpoint_config["Name"] == "Sentinel Hub WMS":
                     collection = handle_SH_WMS_endpoint(
-                        catalog_config, resource, collection_config, catalog
+                        catalog_config, endpoint_config, collection_config, catalog
                     )
-                elif resource["Name"] == "GeoDB":
+                elif endpoint_config["Name"] == "GeoDB":
                     collection = handle_GeoDB_endpoint(
-                        catalog_config, resource, collection_config, catalog
+                        catalog_config, endpoint_config, collection_config, catalog
                     )
-                elif resource["Name"] == "VEDA":
+                elif endpoint_config["Name"] == "VEDA":
                     collection = handle_VEDA_endpoint(
-                        catalog_config, resource, collection_config, catalog, options
+                        catalog_config, endpoint_config, collection_config, catalog, options
                     )
-                elif resource["Name"] == "marinedatastore":
+                elif endpoint_config["Name"] == "marinedatastore":
                     collection = handle_WMS_endpoint(
-                        catalog_config, resource, collection_config, catalog, wmts=True
+                        catalog_config, endpoint_config, collection_config, catalog, wmts=True
                     )
-                elif resource["Name"] == "xcube":
+                elif endpoint_config["Name"] == "xcube":
                     collection = handle_xcube_endpoint(
-                        catalog_config, resource, collection_config, catalog
+                        catalog_config, endpoint_config, collection_config, catalog
                     )
-                elif resource["Name"] == "WMS":
+                elif endpoint_config["Name"] == "WMS":
                     collection = handle_WMS_endpoint(
-                        catalog_config, resource, collection_config, catalog
+                        catalog_config, endpoint_config, collection_config, catalog
                     )
-                elif resource["Name"] == "JAXA_WMTS_PALSAR":
+                elif endpoint_config["Name"] == "JAXA_WMTS_PALSAR":
                     # somewhat one off creation of individual WMTS layers as individual items
                     collection = handle_WMS_endpoint(
-                        catalog_config, resource, collection_config, catalog, wmts=True
+                        catalog_config, endpoint_config, collection_config, catalog, wmts=True
                     )
-                elif resource["Name"] == "Collection-only":
+                elif endpoint_config["Name"] == "Collection-only":
                     collection = handle_collection_only(
-                        catalog_config, resource, collection_config, catalog
+                        catalog_config, endpoint_config, collection_config, catalog
                     )
-                elif resource["Name"] == "Custom-Endpoint":
+                elif endpoint_config["Name"] == "Custom-Endpoint":
                     collection = handle_custom_endpoint(
                         catalog_config,
-                        resource,
+                        endpoint_config,
                         collection_config,
                         catalog,
                     )
-                elif resource["Name"] in ["COG source", "GeoJSON source"]:
+                elif endpoint_config["Name"] in ["COG source", "GeoJSON source"]:
                     collection = handle_raw_source(
-                        catalog_config, resource, collection_config, catalog
+                        catalog_config, endpoint_config, collection_config, catalog
                     )
                 else:
                     raise ValueError("Type of Resource is not supported")
                 if collection:
                     add_single_item_if_collection_empty(collection)
-                    add_projection_info(resource, collection)
-                    add_to_catalog(collection, catalog, resource, collection_config)
+                    add_projection_info(endpoint_config, collection)
+                    add_to_catalog(collection, catalog, endpoint_config, collection_config)
                 else:
-                    raise Exception(f"No collection was generated for resource {resource}")
+                    raise Exception(f"No collection was generated for resource {endpoint_config}")
         elif "Subcollections" in collection_config:
             # if no endpoint is specified we check for definition of subcollections
             parent_collection = get_or_create_collection(

{eodash_catalog-0.0.17 → eodash_catalog-0.0.19}/src/eodash_catalog/stac_handling.py

@@ -112,7 +112,8 @@ def create_web_map_link(layer_config: dict, role: str) -> Link:
             extra_fields["wmts:layer"] = layer_config["layer"]
             if "dimensions" in layer_config:
                 extra_fields["wmts:dimensions"] = layer_config["dimensions"]
-
+    if "Attribution" in layer_config:
+        extra_fields["attribution"] = layer_config["Attribution"]
     wml = Link(
         rel=layer_config["protocol"],
         target=layer_config["url"],
@@ -347,7 +348,7 @@ def add_base_overlay_info(
                 collection.add_link(create_web_map_link(layer, role="overlay"))
 
 
-def add_extra_fields(stac_object: Collection | Catalog | Link, collection_config: dict) -> None:
+def add_extra_fields(stac_object: Collection | Link, collection_config: dict) -> None:
     if "yAxis" in collection_config:
         stac_object.extra_fields["yAxis"] = collection_config["yAxis"]
     if "Themes" in collection_config:
@@ -379,7 +380,7 @@ def add_extra_fields(stac_object: Collection | Catalog | Link, collection_config
         if "Other" in collection_config["DataSource"]:
             stac_object.extra_fields["otherSources"] = collection_config["DataSource"]["Other"]
     if "MapProjection" in collection_config:
-        stac_object.extra_fields["mapProjection"] = collection_config["MapProjection"]
+        stac_object.extra_fields["eodash:mapProjection"] = collection_config["MapProjection"]
 
 
 def get_collection_times_from_config(endpoint_config: dict) -> list[str]:
@@ -416,6 +417,6 @@ def add_projection_info(
             # so we are taking over the DataProjection as is and deal with it in the eodash client
             # in a non-standard compliant way
             # https://github.com/proj4js/proj4js/issues/400
-            stac_object.extra_fields["proj4_def"] = proj
+            stac_object.extra_fields["eodash:proj4_def"] = proj
         else:
             raise Exception(f"Incorrect type of proj definition {proj}")

{eodash_catalog-0.0.17 → eodash_catalog-0.0.19}/tests/test_generate.py

@@ -100,7 +100,7 @@ def test_indicator_map_projection_added(catalog_output_folder):
     with open(os.path.join(root_collection_path, "collection.json")) as fp:
         indicator_json = json.load(fp)
         # test that collection has map projection defined
-        assert indicator_json["mapProjection"] == 3035
+        assert indicator_json["eodash:mapProjection"] == 3035
 
 
 def test_baselayers_and_overlays_added(catalog_output_folder):
@@ -120,6 +120,8 @@ def test_baselayers_and_overlays_added(catalog_output_folder):
         ]
         assert len(baselayer_links) == 1
         assert len(overlay_links) == 1
+        # test that attribution gets passed to a link dict
+        assert "attribution" in baselayer_links[0]
 
 
 def test_geojson_dataset_handled(catalog_output_folder):
@@ -184,4 +186,4 @@ def test_baselayer_with_custom_projection_added(catalog_output_folder):
         # overwrites default_baselayers, so there is just 1
         assert len(baselayer_links) == 1
         # test that custom proj4 definition is added to link
-        assert baselayer_links[0]["proj4_def"]["name"] == "ORTHO:680500"
+        assert baselayer_links[0]["eodash:proj4_def"]["name"] == "ORTHO:680500"

{eodash_catalog-0.0.17 → eodash_catalog-0.0.19}/tests/testing-layers/baselayers.yaml

@@ -2,6 +2,5 @@
   name: EOxCloudless 2022
   url: '//s2maps-tiles.eu/wmts/1.0.0/s2cloudless-2022_3857/default/g/{z}/{y}/{x}.jpeg'
   media_type: image/jpeg
-  attribution: '{ EOxCloudless 2022: <a xmlns:dct="http://purl.org/dc/terms/" href="//s2maps.eu" target="_blank" property="dct:title">Sentinel-2 cloudless - s2maps.eu</a> by <a xmlns:cc="http://creativecommons.org/ns#" href="//eox.at" target="_blank" property="cc:attributionName" rel="cc:attributionURL">EOX IT Services GmbH</a> (Contains modified Copernicus Sentinel data 2022) }'
-  maxNativeZoom: 17
+  Attribution: '{ EOxCloudless 2022: <a xmlns:dct="http://purl.org/dc/terms/" href="//s2maps.eu" target="_blank" property="dct:title">Sentinel-2 cloudless - s2maps.eu</a> by <a xmlns:cc="http://creativecommons.org/ns#" href="//eox.at" target="_blank" property="cc:attributionName" rel="cc:attributionURL">EOX IT Services GmbH</a> (Contains modified Copernicus Sentinel data 2022) }'
   protocol: 'xyz'

{eodash_catalog-0.0.17 → eodash_catalog-0.0.19}/tests/testing-layers/overlays.yaml

@@ -1,7 +1,6 @@
 - id: overlay_bright
   name: 'Overlay labels'
   url: '//s2maps-tiles.eu/wmts/1.0.0/overlay_base_bright_3857/default/g/{z}/{y}/{x}.png'
-  attribution: '{ Overlay: Data &copy; <a href="http://www.openstreetmap.org/copyright" target="_blank">OpenStreetMap</a> contributors, Made with Natural Earth, Rendering &copy; <a href="//eox.at" target="_blank">EOX</a> }'
+  Attribution: '{ Overlay: Data &copy; <a href="http://www.openstreetmap.org/copyright" target="_blank">OpenStreetMap</a> contributors, Made with Natural Earth, Rendering &copy; <a href="//eox.at" target="_blank">EOX</a> }'
   visible: true
-  maxNativeZoom: 14
-  protocol: 'xyz'
+  protocol: 'xyz'