clarity-api-sdk-python 0.1.0__tar.gz → 0.1.4__tar.gz

{clarity_api_sdk_python-0.1.0 → clarity_api_sdk_python-0.1.4}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.1.0
-Summary: A Python SDK to connect to the CTI API server.
+Version: 0.1.4
+Summary: A Python SDK to connect to the CTI Clarity API server.
 Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
 Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python
 Classifier: Programming Language :: Python :: 3
@@ -9,7 +9,16 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: brotli
+Requires-Dist: h2
+Requires-Dist: httpx_auth>=0.23.1
+Requires-Dist: httpx-retries>=0.4.5
 Requires-Dist: structlog
+Provides-Extra: brotli
+Requires-Dist: httpx[brotli]>=0.28.1; extra == "brotli"
+Provides-Extra: http2
+Requires-Dist: httpx[http2]>=0.28.1; extra == "http2"
 
 # Clarity API SDK for Python
 

{clarity_api_sdk_python-0.1.0 → clarity_api_sdk_python-0.1.4}/pyproject.toml

@@ -5,11 +5,11 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "clarity-api-sdk-python"
-version = "0.1.0"
+version = "0.1.4"
 authors = [
   { name="Chesapeake Technology Inc.", email="support@chesapeaketech.com" },
 ]
-description = "A Python SDK to connect to the CTI API server."
+description = "A Python SDK to connect to the CTI Clarity API server."
 readme = "README.md"
 requires-python = ">=3.12"
 classifiers = [
@@ -18,9 +18,18 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
+    "httpx>=0.28.1",
+    "brotli",
+    "h2",
+    "httpx_auth>=0.23.1",
+    "httpx-retries>=0.4.5",
     "structlog",
 ]
 
+[project.optional-dependencies]
+brotli = ["httpx[brotli]>=0.28.1"]
+http2 = ["httpx[http2]>=0.28.1"]
+
 [project.urls]
 "Homepage" = "https://github.com/chesapeake-tech/clarity-api-sdk-python"
 

clarity_api_sdk_python-0.1.4/src/api/__init__.py

@@ -0,0 +1,3 @@
+"""API client"""
+
+from .client import ClarityApiClient

clarity_api_sdk_python-0.1.4/src/api/client.py

@@ -0,0 +1,124 @@
+"""client for clarity API"""
+
+import os
+import uuid
+
+from httpx import Client, HTTPStatusError, RequestError, Response, URL
+from httpx_auth import OAuth2ClientCredentials, OAuth2, TokenMemoryCache
+from httpx_retries import Retry, RetryTransport
+
+from logger import get_logger
+
+logger = get_logger(__name__)
+OAuth2.token_cache = TokenMemoryCache()
+
+
+class ClarityApiClient(Client):
+    """Client for Clarity API configured with OAuth2 authentication, retry mechanism
+    and other defaults to connect to the clarity server.
+
+    Reuse this client instance for multiple requests for faster performance.
+    """
+
+    def __init__(self):
+
+        # credentials for Clarity API
+        cti_credentials = OAuth2ClientCredentials(
+            token_url=(
+                f'{os.environ.get("KEYCLOAK_SERVER_URL", "missing KEYCLOAK_SERVER_URL")}/realms/'
+                f'{os.environ.get("KEYCLOAK_REALM", "missing KEYCLOAK_REALM")}'
+                "/protocol/openid-connect/token"
+            ),
+            client_id=os.environ.get(
+                "KEYCLOAK_CLIENT_ID", "missing KEYCLOAK_CLIENT_ID"
+            ),
+            client_secret=os.environ.get(
+                "KEYCLOAK_CLIENT_SECRET", "missing KEYCLOAK_CLIENT_SECRET"
+            ),
+        )
+
+        # retry mechanism for API requests
+        retry = Retry(total=12, backoff_factor=0.5)
+        transport = RetryTransport(retry=retry)
+
+        super().__init__(
+            base_url=os.environ.get("CLARITY_API_URL", "missing Clarity_API_URL"),
+            auth=cti_credentials,
+            timeout=60,
+            transport=transport,
+            http2=True,
+            headers={"Accept": "application/json"},
+        )
+
+    def request(self, method: str, url: URL | str, **kwargs) -> Response:
+        """Make a request to the Clarity API and handle exceptions.
+
+        The exceptions are caught and logged, and then re-raised.
+
+        Args:
+            method: HTTP method (GET, POST, PUT, DELETE, etc.)
+            url: relative URL for the request, eg: "/api/v1/projects/12345"
+            kwargs: additional keyword arguments to be passed to the request
+
+        Returns:
+            httpx.Response: Response from the API
+
+        Raises:
+            RequestError: If there was an issue with the request
+            HTTPStatusError: If the response status code is not in the 2xx range
+            Exception: For any other uncaught exception
+        """
+        try:
+            request_id = str(uuid.uuid4())
+            if "headers" not in kwargs or kwargs["headers"] is None:
+                kwargs["headers"] = {}
+            # append x-request-id header to the kwargs "headers"
+            kwargs["headers"].update({"x-request-id": request_id})
+            logger.info(
+                "request",
+                extra={"url": url, "request_id": request_id},
+            )
+            # make the actual request and return the response
+            response = super().request(method, url, **kwargs)
+            # raise an exception if the response status is not in the 2xx range
+            response.raise_for_status()
+            logger.info(
+                "response",
+                extra={
+                    "request_id": request_id,
+                    "response": {"status_code": response.status_code},
+                },
+            )
+            return response
+        except HTTPStatusError as e:
+            logger.error(
+                "http",
+                extra={
+                    "request": {
+                        "method": e.request.method,
+                        "url": str(e.request.url),
+                        "headers": dict(e.request.headers),
+                    },
+                    "error": {
+                        "message": str(e.response.content),
+                        "status_code": e.response.status_code,
+                        "headers": dict(e.response.headers),
+                    },
+                },
+            )
+            raise e
+        except RequestError as e:
+            logger.error(
+                "request",
+                extra={
+                    "request": {
+                        "method": e.request.method,
+                        "url": str(e.request.url),
+                        "headers": dict(e.request.headers),
+                    },
+                    "error": {
+                        "message": str(e),
+                    },
+                },
+            )
+            raise e

{clarity_api_sdk_python-0.1.0 → clarity_api_sdk_python-0.1.4}/src/clarity_api_sdk_python.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.1.0
-Summary: A Python SDK to connect to the CTI API server.
+Version: 0.1.4
+Summary: A Python SDK to connect to the CTI Clarity API server.
 Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
 Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python
 Classifier: Programming Language :: Python :: 3
@@ -9,7 +9,16 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: brotli
+Requires-Dist: h2
+Requires-Dist: httpx_auth>=0.23.1
+Requires-Dist: httpx-retries>=0.4.5
 Requires-Dist: structlog
+Provides-Extra: brotli
+Requires-Dist: httpx[brotli]>=0.28.1; extra == "brotli"
+Provides-Extra: http2
+Requires-Dist: httpx[http2]>=0.28.1; extra == "http2"
 
 # Clarity API SDK for Python
 

{clarity_api_sdk_python-0.1.0 → clarity_api_sdk_python-0.1.4}/src/clarity_api_sdk_python.egg-info/SOURCES.txt

@@ -1,5 +1,7 @@
 README.md
 pyproject.toml
+src/api/__init__.py
+src/api/client.py
 src/clarity_api_sdk_python.egg-info/PKG-INFO
 src/clarity_api_sdk_python.egg-info/SOURCES.txt
 src/clarity_api_sdk_python.egg-info/dependency_links.txt

clarity_api_sdk_python-0.1.4/src/clarity_api_sdk_python.egg-info/requires.txt

@@ -0,0 +1,12 @@
+httpx>=0.28.1
+brotli
+h2
+httpx_auth>=0.23.1
+httpx-retries>=0.4.5
+structlog
+
+[brotli]
+httpx[brotli]>=0.28.1
+
+[http2]
+httpx[http2]>=0.28.1

{clarity_api_sdk_python-0.1.0 → clarity_api_sdk_python-0.1.4}/src/clarity_api_sdk_python.egg-info/top_level.txt

@@ -1 +1,2 @@
+api
 logger

clarity_api_sdk_python-0.1.4/src/logger/__init__.py

@@ -0,0 +1,3 @@
+"""import modules"""
+
+from .logger import get_logger, initialize_logger, ExternalLoggerConfig  # noqa

{clarity_api_sdk_python-0.1.0 → clarity_api_sdk_python-0.1.4}/src/logger/logger.py

@@ -5,7 +5,6 @@ from dataclasses import dataclass
 import logging
 import socket
 import sys
-from typing import Optional
 import urllib.error
 import urllib.request
 
@@ -167,8 +166,8 @@ def _secret_redaction_processor(_, __, event_dict):
 
 
 def initialize_logger(
-    initial_context: Optional[dict] = None,
-    external_logger_configurations: Optional[list[ExternalLoggerConfig]] = None,
+    initial_context: dict | None = None,
+    external_logger_configurations: list[ExternalLoggerConfig] | None = None,
 ) -> None:
     """Configures logging for the application using structlog.
 

clarity_api_sdk_python-0.1.0/src/clarity_api_sdk_python.egg-info/requires.txt

@@ -1 +0,0 @@
-structlog

clarity_api_sdk_python-0.1.0/src/logger/__init__.py

@@ -1,3 +0,0 @@
-"""import modules"""
-
-from .logger import get_logger, initialize_logger  # noqa