opensecureconf-client 1.0.1__tar.gz → 1.0.2__tar.gz

{opensecureconf_client-1.0.1/opensecureconf_client.egg-info → opensecureconf_client-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opensecureconf-client
-Version: 1.0.1
+Version: 1.0.2
 Summary: Python client library for OpenSecureConf encrypted configuration management API
 Author-email: Alessandro Pioli <alessandro.pioli+apioli-pypi@gmail.com>
 Maintainer-email: Alessandro Pioli <alessandro.pioli+apioli-pypi@gmail.com>

{opensecureconf_client-1.0.1 → opensecureconf_client-1.0.2/opensecureconf_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opensecureconf-client
-Version: 1.0.1
+Version: 1.0.2
 Summary: Python client library for OpenSecureConf encrypted configuration management API
 Author-email: Alessandro Pioli <alessandro.pioli+apioli-pypi@gmail.com>
 Maintainer-email: Alessandro Pioli <alessandro.pioli+apioli-pypi@gmail.com>

{opensecureconf_client-1.0.1 → opensecureconf_client-1.0.2}/opensecureconf_client.py

@@ -5,29 +5,26 @@ A Python client library for interacting with the OpenSecureConf API,
 which provides encrypted configuration management with multithreading support.
 """
 
+from typing import Any, Dict, List, Optional
+
 import requests
-from typing import Optional, Dict, Any, List
-from requests.exceptions import RequestException, HTTPError, ConnectionError, Timeout
+from requests.exceptions import Timeout
 
 
 class OpenSecureConfError(Exception):
     """Base exception for OpenSecureConf client errors."""
-    pass
 
 
 class AuthenticationError(OpenSecureConfError):
     """Raised when authentication fails (invalid or missing user key)."""
-    pass
 
 
 class ConfigurationNotFoundError(OpenSecureConfError):
     """Raised when a requested configuration key does not exist."""
-    pass
 
 
 class ConfigurationExistsError(OpenSecureConfError):
     """Raised when attempting to create a configuration that already exists."""
-    pass
 
 
 class OpenSecureConfClient:
@@ -40,12 +37,14 @@ class OpenSecureConfClient:
     Attributes:
         base_url (str): The base URL of the OpenSecureConf API server.
         user_key (str): The encryption key used for authentication and encryption/decryption.
+        api_key (Optional[str]): Optional API key for additional authentication.
         timeout (int): Request timeout in seconds.
 
     Example:
         >>> client = OpenSecureConfClient(
         ...     base_url="http://localhost:9000",
-        ...     user_key="my-secret-key-123"
+        ...     user_key="my-secret-key-123",
+        ...     api_key="optional-api-key"
         ... )
         >>> config = client.create("database", {"host": "localhost", "port": 5432})
         >>> print(config["value"])
@@ -56,6 +55,7 @@ class OpenSecureConfClient:
         self,
         base_url: str,
         user_key: str,
+        api_key: Optional[str] = None,
         timeout: int = 30,
         verify_ssl: bool = True
     ):
@@ -65,6 +65,7 @@ class OpenSecureConfClient:
         Args:
             base_url: The base URL of the OpenSecureConf API (e.g., "http://localhost:9000")
             user_key: User encryption key for authentication (minimum 8 characters)
+            api_key: Optional API key for additional authentication
             timeout: Request timeout in seconds (default: 30)
             verify_ssl: Whether to verify SSL certificates (default: True)
 
@@ -76,20 +77,24 @@ class OpenSecureConfClient:
 
         self.base_url = base_url.rstrip("/")
         self.user_key = user_key
+        self.api_key = api_key
         self.timeout = timeout
         self.verify_ssl = verify_ssl
         self._session = requests.Session()
-        self._session.headers.update({
-            "x-user-key": self.user_key,
+
+        # Setup headers
+        headers = {
+            "x-user-key": self.user_key, 
             "Content-Type": "application/json"
-        })
+        }
 
-    def _make_request(
-        self,
-        method: str,
-        endpoint: str,
-        **kwargs
-    ) -> Any:
+        # Add X-API-Key header if api_key is provided
+        if self.api_key:
+            headers["X-API-Key"] = self.api_key
+
+        self._session.headers.update(headers)
+
+    def _make_request(self, method: str, endpoint: str, **kwargs) -> Any:
         """
         Make an HTTP request to the API with error handling.
 
@@ -116,17 +121,21 @@ class OpenSecureConfClient:
             response = self._session.request(method, url, **kwargs)
 
             if response.status_code == 401:
-                raise AuthenticationError("Authentication failed: invalid or missing user key")
-            elif response.status_code == 404:
+                raise AuthenticationError(
+                    "Authentication failed: invalid or missing user key"
+                )
+            if response.status_code == 404:
                 raise ConfigurationNotFoundError("Configuration not found")
-            elif response.status_code == 400:
+            if response.status_code == 400:
                 error_detail = response.json().get("detail", "Bad request")
                 if "already exists" in error_detail.lower():
                     raise ConfigurationExistsError(error_detail)
                 raise OpenSecureConfError(f"Bad request: {error_detail}")
-            elif response.status_code >= 400:
+            if response.status_code >= 400:
                 error_detail = response.json().get("detail", "Unknown error")
-                raise OpenSecureConfError(f"API error ({response.status_code}): {error_detail}")
+                raise OpenSecureConfError(
+                    f"API error ({response.status_code}): {error_detail}"
+                )
 
             if response.status_code == 204 or not response.content:
                 return None
@@ -134,9 +143,11 @@ class OpenSecureConfClient:
             return response.json()
 
         except (ConnectionError, Timeout) as e:
-            raise ConnectionError(f"Failed to connect to {self.base_url}: {str(e)}")
+            raise ConnectionError(
+                f"Failed to connect to {self.base_url}: {str(e)}"
+            ) from e
         except ValueError as e:
-            raise OpenSecureConfError(f"Invalid JSON response: {str(e)}")
+            raise OpenSecureConfError(f"Invalid JSON response: {str(e)}") from e
 
     def get_service_info(self) -> Dict[str, Any]:
         """
@@ -153,10 +164,7 @@ class OpenSecureConfClient:
         return self._make_request("GET", "/")
 
     def create(
-        self,
-        key: str,
-        value: Dict[str, Any],
-        category: Optional[str] = None
+        self, key: str, value: Dict[str, Any], category: Optional[str] = None
     ) -> Dict[str, Any]:
         """
         Create a new encrypted configuration entry.
@@ -187,11 +195,7 @@ class OpenSecureConfClient:
         if not key or len(key) > 255:
             raise ValueError("Key must be between 1 and 255 characters")
 
-        payload = {
-            "key": key,
-            "value": value,
-            "category": category
-        }
+        payload = {"key": key, "value": value, "category": category}
 
         return self._make_request("POST", "/configs", json=payload)
 
@@ -216,10 +220,7 @@ class OpenSecureConfClient:
         return self._make_request("GET", f"/configs/{key}")
 
     def update(
-        self,
-        key: str,
-        value: Dict[str, Any],
-        category: Optional[str] = None
+        self, key: str, value: Dict[str, Any], category: Optional[str] = None
     ) -> Dict[str, Any]:
         """
         Update an existing configuration entry with new encrypted value.
@@ -241,10 +242,7 @@ class OpenSecureConfClient:
             ...     value={"host": "db.example.com", "port": 5432}
             ... )
         """
-        payload = {
-            "value": value,
-            "category": category
-        }
+        payload = {"value": value, "category": category}
 
         return self._make_request("PUT", f"/configs/{key}", json=payload)
 
@@ -312,5 +310,5 @@ __all__ = [
     "OpenSecureConfError",
     "AuthenticationError",
     "ConfigurationNotFoundError",
-    "ConfigurationExistsError"
+    "ConfigurationExistsError",
 ]

{opensecureconf_client-1.0.1 → opensecureconf_client-1.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "opensecureconf-client"
-version = "1.0.1"
+version = "1.0.2"
 description = "Python client library for OpenSecureConf encrypted configuration management API"
 readme = "README.md"
 requires-python = ">=3.8"

{opensecureconf_client-1.0.1 → opensecureconf_client-1.0.2}/setup.py

@@ -2,6 +2,7 @@
 Setup script for backward compatibility.
 Modern projects should use pyproject.toml instead.
 """
+
 from setuptools import setup
 
 setup()