geoservercloud 0.7.3.dev3__tar.gz → 0.7.4.dev1__tar.gz

{geoservercloud-0.7.3.dev3 → geoservercloud-0.7.4.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: geoservercloud
-Version: 0.7.3.dev3
+Version: 0.7.4.dev1
 Summary: Lightweight Python client to interact with GeoServer Cloud REST API, GeoServer ACL and OGC services
 License: BSD-2-Clause
 Author: Camptocamp
@@ -154,3 +154,13 @@ First install the package in your current virtual environment (see [Installation
 copy-workspace --src_url "http://localhost:8080/geoserver" --src_user admin --src_password geoserver --dst_url "http://localhost:9099/geoserver" --dst_user admin --dst_password geoserver --workspace workspace_name
 ```
 
+### Logging
+
+Set the log level using the standard `logging` module, e.g.:
+
+```python
+import logging
+
+logging.getLogger("geoservercloud").setLevel(logging.DEBUG)
+```
+

{geoservercloud-0.7.3.dev3 → geoservercloud-0.7.4.dev1}/README.md

@@ -131,3 +131,13 @@ First install the package in your current virtual environment (see [Installation
 ```shell
 copy-workspace --src_url "http://localhost:8080/geoserver" --src_user admin --src_password geoserver --dst_url "http://localhost:9099/geoserver" --dst_user admin --dst_password geoserver --workspace workspace_name
 ```
+
+### Logging
+
+Set the log level using the standard `logging` module, e.g.:
+
+```python
+import logging
+
+logging.getLogger("geoservercloud").setLevel(logging.DEBUG)
+```

{geoservercloud-0.7.3.dev3 → geoservercloud-0.7.4.dev1}/geoserver_acceptance_tests/config.py

@@ -1,3 +1,4 @@
+import logging
 import os
 
 import yaml
@@ -54,4 +55,28 @@ def load_config():
     if override_pg_schema:
         config["db"]["pg_schema"] = override_pg_schema
 
+    # Configure logging for geoservercloud library
+    _setup_logging(config)
+
     return config
+
+
+def _setup_logging(config: dict):
+    """Set up logging for the geoservercloud library based on configuration."""
+    # Get logging configuration from config file or use defaults
+    log_config = config.get("logging", {})
+    log_level_str = log_config.get("level", "INFO").upper()
+    log_level = getattr(logging, log_level_str, logging.INFO)
+    log_format = log_config.get(
+        "format", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+    )
+
+    # Configure the geoservercloud logger
+    logger = logging.getLogger("geoservercloud")
+    logger.setLevel(log_level)
+
+    # Add console handler if not already present
+    if not logger.handlers:
+        handler = logging.StreamHandler()
+        handler.setFormatter(logging.Formatter(log_format))
+        logger.addHandler(handler)

{geoservercloud-0.7.3.dev3 → geoservercloud-0.7.4.dev1}/geoserver_acceptance_tests/example.config.yaml

@@ -6,6 +6,10 @@ credentials:
   user: "admin"
   pass: "geoserver"
 
+logging:
+  level: "DEBUG"
+  format: "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+
 db:
   pg_host:
     docker: "geodatabase"

{geoservercloud-0.7.3.dev3 → geoservercloud-0.7.4.dev1}/geoservercloud/geoservercloud.py

@@ -10,7 +10,7 @@ from geoservercloud import utils
 from geoservercloud.models.common import TimeDimensionInfo
 from geoservercloud.models.coverage import Coverage
 from geoservercloud.models.coveragestore import CoverageStore
-from geoservercloud.models.datastore import PostGisDataStore
+from geoservercloud.models.datastore import DataStore
 from geoservercloud.models.featuretype import FeatureType
 from geoservercloud.models.layer import Layer
 from geoservercloud.models.layergroup import LayerGroup
@@ -272,19 +272,94 @@ class GeoServerCloud:
             return datastores, status_code
         return datastores.aslist(), status_code
 
-    def get_pg_datastore(
+    def get_datastore(
         self, workspace_name: str, datastore_name: str
     ) -> tuple[dict[str, Any] | str, int]:
         """
         Get a datastore by workspace and name
         """
-        datastore, status_code = self.rest_service.get_pg_datastore(
+        datastore, status_code = self.rest_service.get_datastore(
             workspace_name, datastore_name
         )
         if isinstance(datastore, str):
             return datastore, status_code
         return datastore.asdict(), status_code
 
+    def get_pg_datastore(
+        self, workspace_name: str, datastore_name: str
+    ) -> tuple[dict[str, Any] | str, int]:
+        """
+        Get a datastore by workspace and name
+        """
+        return self.get_datastore(workspace_name, datastore_name)
+
+    def create_datastore(
+        self,
+        workspace_name: str,
+        datastore_name: str,
+        datastore_type: str,
+        connection_parameters: dict[str, Any],
+        description: str | None = None,
+        enabled: bool = True,
+        set_default_datastore: bool = False,
+    ) -> tuple[str, int]:
+        """
+        Create a generic datastore of any type in GeoServer, or update if it already exists. This method
+        accepts flexible connection parameters, allowing to create any type of datastore.
+
+        :param workspace_name: Name of the workspace
+        :type workspace_name: str
+        :param datastore_name: Name for the datastore
+        :type datastore_name: str
+        :param datastore_type: Type of datastore (e.g., "PostGIS", "Shapefile", "Directory of spatial files (shapefiles)")
+        :type datastore_type: str
+        :param connection_parameters: Dict of connection parameters specific to the datastore type
+        :type connection_parameters: dict
+        :param description: Optional description
+        :type description: str, optional
+        :param enabled: Whether the datastore should be enabled (default: True)
+        :type enabled: bool, optional
+        :param set_default_datastore: Whether to set as default datastore (default: False)
+        :type set_default_datastore: bool, optional
+
+        :return: Tuple of (datastore_name, status_code)
+        :rtype: tuple
+
+        :Example:
+
+        >>> create_datastore(
+        ...     workspace_name="myworkspace",
+        ...     datastore_name="my_store",
+        ...     datastore_type="PostGIS",
+        ...     connection_parameters={
+        ...         "dbtype": "postgis",
+        ...         "host": "localhost",
+        ...         "port": 5432,
+        ...         "database": "mydb",
+        ...         "user": "user",
+        ...         "passwd": "password",
+        ...         "schema": "public",
+        ...         "Expose primary keys": "true",
+        ...     }
+        ... )
+        """
+        datastore = DataStore(
+            workspace_name,
+            datastore_name,
+            connection_parameters=connection_parameters,
+            type=datastore_type,
+            description=description,
+            enabled=enabled,
+        )
+        content, status_code = self.rest_service.create_datastore(
+            workspace_name, datastore
+        )
+
+        if set_default_datastore:
+            self.default_datastore = datastore_name
+
+        return content, status_code
+
     def create_pg_datastore(
         self,
         workspace_name: str,
@@ -301,7 +376,7 @@ class GeoServerCloud:
         """
         Create a PostGIS datastore from the DB connection parameters, or update it if it already exist.
         """
-        datastore = PostGisDataStore(
+        datastore = DataStore(
             workspace_name,
             datastore_name,
             connection_parameters={
@@ -318,7 +393,7 @@ class GeoServerCloud:
             type="PostGIS",
             description=description,
         )
-        content, status_code = self.rest_service.create_pg_datastore(
+        content, status_code = self.rest_service.create_datastore(
             workspace_name, datastore
         )
 
@@ -339,7 +414,7 @@ class GeoServerCloud:
         """
         Create a PostGIS datastore from JNDI resource, or update it if it already exist.
         """
-        datastore = PostGisDataStore(
+        datastore = DataStore(
             workspace_name,
             datastore_name,
             connection_parameters={
@@ -352,9 +427,7 @@ class GeoServerCloud:
             type="PostGIS (JNDI)",
             description=description,
         )
-        content, code = self.rest_service.create_jndi_datastore(
-            workspace_name, datastore
-        )
+        content, code = self.rest_service.create_datastore(workspace_name, datastore)
 
         if set_default_datastore:
             self.default_datastore = datastore_name

{geoservercloud-0.7.3.dev3 → geoservercloud-0.7.4.dev1}/geoservercloud/geoservercloudsync.py

@@ -106,12 +106,12 @@ class GeoServerCloudSync:
         Copy a datastore from source to destination GeoServer instance
         If deep_copy is True, copy all feature types and the corresponding layers
         """
-        datastore, status_code = self.src_instance.get_pg_datastore(
+        datastore, status_code = self.src_instance.get_datastore(
             workspace_name, datastore_name
         )
         if isinstance(datastore, str):
             return datastore, status_code
-        new_ds, new_ds_status_code = self.dst_instance.create_pg_datastore(
+        new_ds, new_ds_status_code = self.dst_instance.create_datastore(
             workspace_name, datastore
         )
         if self.not_ok(new_ds_status_code):

{geoservercloud-0.7.3.dev3 → geoservercloud-0.7.4.dev1}/geoservercloud/models/datastore.py

@@ -8,13 +8,13 @@ from geoservercloud.models.common import (
 )
 
 
-class PostGisDataStore(EntityModel):
+class DataStore(EntityModel):
     def __init__(
         self,
         workspace_name: str,
         name: str,
         connection_parameters: dict,
-        type: str = "PostGIS",
+        type: str,
         enabled: bool = True,
         description: str | None = None,
         default: bool | None = None,
@@ -73,7 +73,7 @@ class PostGisDataStore(EntityModel):
             data_store["workspace"]["name"],
             data_store["name"],
             connection_parameters,
-            data_store.get("type", "PostGIS"),
+            data_store["type"],
             data_store.get("enabled", True),
             data_store.get("description", None),
             data_store.get("_default", None),

{geoservercloud-0.7.3.dev3 → geoservercloud-0.7.4.dev1}/geoservercloud/services/restclient.py

@@ -58,6 +58,7 @@ class RestClient:
         data: bytes | str | None = None,
     ) -> requests.Response:
         full_url = f"{self.url}{path}"
+        self.log_payload("POST", json, data)
         response: requests.Response = requests.post(
             full_url,
             params=params,
@@ -87,6 +88,7 @@ class RestClient:
         data: bytes | str | None = None,
     ) -> requests.Response:
         full_url = f"{self.url}{path}"
+        self.log_payload("PUT", json, data)
         response: requests.Response = requests.put(
             full_url,
             params=params,
@@ -130,3 +132,16 @@ class RestClient:
         if response.status_code != 404:
             response.raise_for_status()
         return response
+
+    def log_payload(
+        self, method: str, json: dict | None, data: bytes | str | None
+    ) -> None:
+        payload_string = None
+        if json is not None:
+            payload_string = str(json)
+        elif data is not None:
+            if isinstance(data, str):
+                payload_string = data
+            else:
+                payload_string = f"<binary data, {len(data)} bytes>"
+        gs_logger.debug("Doing %s request with payload: %s", method, payload_string)

geoservercloud-0.7.4.dev1/geoservercloud/services/restlogger.py

@@ -0,0 +1,5 @@
+import logging
+
+gs_logger = logging.getLogger("geoservercloud")
+# Prevent "No handler found" warnings if the application doesn't configure logging
+gs_logger.addHandler(logging.NullHandler())

{geoservercloud-0.7.3.dev3 → geoservercloud-0.7.4.dev1}/geoservercloud/services/restservice.py

@@ -9,7 +9,7 @@ from geoservercloud.models.common import BaseModel
 from geoservercloud.models.coverage import Coverage
 from geoservercloud.models.coverages import Coverages
 from geoservercloud.models.coveragestore import CoverageStore
-from geoservercloud.models.datastore import PostGisDataStore
+from geoservercloud.models.datastore import DataStore
 from geoservercloud.models.datastores import DataStores
 from geoservercloud.models.featuretype import FeatureType
 from geoservercloud.models.featuretypes import FeatureTypes
@@ -113,33 +113,16 @@ class RestService:
         )
         return self.deserialize_response(response, DataStores)
 
-    def get_pg_datastore(
+    def get_datastore(
         self, workspace_name: str, datastore_name: str
-    ) -> tuple[PostGisDataStore | str, int]:
+    ) -> tuple[DataStore | str, int]:
         response: Response = self.rest_client.get(
             self.rest_endpoints.datastore(workspace_name, datastore_name)
         )
-        return self.deserialize_response(response, PostGisDataStore)
+        return self.deserialize_response(response, DataStore)
 
-    def create_pg_datastore(
-        self, workspace_name: str, datastore: PostGisDataStore
-    ) -> tuple[str, int]:
-        if not self.resource_exists(
-            self.rest_endpoints.datastore(workspace_name, datastore.name)
-        ):
-            response: Response = self.rest_client.post(
-                self.rest_endpoints.datastores(workspace_name),
-                json=datastore.post_payload(),
-            )
-        else:
-            response = self.rest_client.put(
-                self.rest_endpoints.datastore(workspace_name, datastore.name),
-                json=datastore.put_payload(),
-            )
-        return response.content.decode(), response.status_code
-
-    def create_jndi_datastore(
-        self, workspace_name: str, datastore: PostGisDataStore
+    def create_datastore(
+        self, workspace_name: str, datastore: DataStore
     ) -> tuple[str, int]:
         if not self.resource_exists(
             self.rest_endpoints.datastore(workspace_name, datastore.name)

{geoservercloud-0.7.3.dev3 → geoservercloud-0.7.4.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "geoservercloud"
-version = "0.7.3.dev3"
+version = "0.7.4.dev1"
 description = "Lightweight Python client to interact with GeoServer Cloud REST API, GeoServer ACL and OGC services"
 authors = ["Camptocamp <info@camptocamp.com>"]
 license = "BSD-2-Clause"

geoservercloud-0.7.3.dev3/geoservercloud/services/restlogger.py

@@ -1,12 +0,0 @@
-import logging
-
-time_formatter = logging.Formatter(
-    "{asctime} - {name}:{levelname} - {message}",
-    style="{",
-    datefmt="%Y-%m-%d %H:%M",
-)
-stream_handler = logging.StreamHandler()
-stream_handler.setFormatter(time_formatter)
-gs_logger = logging.getLogger("GS Session")
-gs_logger.setLevel(logging.INFO)
-gs_logger.addHandler(stream_handler)