clarity-api-sdk-python 0.1.8__tar.gz → 0.2.11__tar.gz

{clarity_api_sdk_python-0.1.8 → clarity_api_sdk_python-0.2.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.1.8
+Version: 0.2.11
 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
@@ -22,7 +22,7 @@ Requires-Dist: httpx[http2]>=0.28.1; extra == "http2"
 
 # Clarity API SDK for Python
 
-[![PyPI - Downloads](https://badge.fury.io/py/clarity-api-sdk-python.svg)](https://test.pypi.org/project/clarity-api-sdk-python/)
+[![PyPI - Downloads](https://badge.fury.io/py/clarity-api-sdk-python.svg)](https://pypi.org/project/clarity-api-sdk-python/)
 [![Downloads](https://pepy.tech/badge/clarity-api-sdk-python)](ttps://test.pypi.org/project/clarity-api-sdk-python/)
 ![python](https://img.shields.io/badge/python-3.11%2B-blue)
 
@@ -38,7 +38,7 @@ pip install clarity-api-sdk-python
 
 Logging support is built with [structlog](https://pypi.org/project/structlog/).
 
-Set the root logger by setting the environment variable `LOGGING_LEVEL`. Otherwise, the default root logging is set to `ERROR`.
+Set the root logger by setting the environment variable `LOG_LEVEL`. Otherwise, the default root logging is set to `INFO`.
 
 ```python
 """Example"""
@@ -54,7 +54,8 @@ initialize_logger(
         ExternalLoggerConfig(name="httpx"),
         ExternalLoggerConfig(name="httpx_auth"),
         ExternalLoggerConfig(name="httpx_retries"),
-    ]
+    ],
+    handlers=[logging.FileHandler("app.log")]
 )
 
 logger_a = get_logger("logger_a")

{clarity_api_sdk_python-0.1.8 → clarity_api_sdk_python-0.2.11}/README.md

@@ -1,6 +1,6 @@
 # Clarity API SDK for Python
 
-[![PyPI - Downloads](https://badge.fury.io/py/clarity-api-sdk-python.svg)](https://test.pypi.org/project/clarity-api-sdk-python/)
+[![PyPI - Downloads](https://badge.fury.io/py/clarity-api-sdk-python.svg)](https://pypi.org/project/clarity-api-sdk-python/)
 [![Downloads](https://pepy.tech/badge/clarity-api-sdk-python)](ttps://test.pypi.org/project/clarity-api-sdk-python/)
 ![python](https://img.shields.io/badge/python-3.11%2B-blue)
 
@@ -16,7 +16,7 @@ pip install clarity-api-sdk-python
 
 Logging support is built with [structlog](https://pypi.org/project/structlog/).
 
-Set the root logger by setting the environment variable `LOGGING_LEVEL`. Otherwise, the default root logging is set to `ERROR`.
+Set the root logger by setting the environment variable `LOG_LEVEL`. Otherwise, the default root logging is set to `INFO`.
 
 ```python
 """Example"""
@@ -32,7 +32,8 @@ initialize_logger(
         ExternalLoggerConfig(name="httpx"),
         ExternalLoggerConfig(name="httpx_auth"),
         ExternalLoggerConfig(name="httpx_retries"),
-    ]
+    ],
+    handlers=[logging.FileHandler("app.log")]
 )
 
 logger_a = get_logger("logger_a")

{clarity_api_sdk_python-0.1.8 → clarity_api_sdk_python-0.2.11}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "clarity-api-sdk-python"
-version = "0.1.8"
+version = "0.2.11"
 authors = [
   { name="Chesapeake Technology Inc.", email="support@chesapeaketech.com" },
 ]

{clarity_api_sdk_python-0.1.8 → clarity_api_sdk_python-0.2.11}/src/clarity_api_sdk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.1.8
+Version: 0.2.11
 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
@@ -22,7 +22,7 @@ Requires-Dist: httpx[http2]>=0.28.1; extra == "http2"
 
 # Clarity API SDK for Python
 
-[![PyPI - Downloads](https://badge.fury.io/py/clarity-api-sdk-python.svg)](https://test.pypi.org/project/clarity-api-sdk-python/)
+[![PyPI - Downloads](https://badge.fury.io/py/clarity-api-sdk-python.svg)](https://pypi.org/project/clarity-api-sdk-python/)
 [![Downloads](https://pepy.tech/badge/clarity-api-sdk-python)](ttps://test.pypi.org/project/clarity-api-sdk-python/)
 ![python](https://img.shields.io/badge/python-3.11%2B-blue)
 
@@ -38,7 +38,7 @@ pip install clarity-api-sdk-python
 
 Logging support is built with [structlog](https://pypi.org/project/structlog/).
 
-Set the root logger by setting the environment variable `LOGGING_LEVEL`. Otherwise, the default root logging is set to `ERROR`.
+Set the root logger by setting the environment variable `LOG_LEVEL`. Otherwise, the default root logging is set to `INFO`.
 
 ```python
 """Example"""
@@ -54,7 +54,8 @@ initialize_logger(
         ExternalLoggerConfig(name="httpx"),
         ExternalLoggerConfig(name="httpx_auth"),
         ExternalLoggerConfig(name="httpx_retries"),
-    ]
+    ],
+    handlers=[logging.FileHandler("app.log")]
 )
 
 logger_a = get_logger("logger_a")

{clarity_api_sdk_python-0.1.8 → clarity_api_sdk_python-0.2.11}/src/clarity_api_sdk_python.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ src/clarity_api_sdk_python.egg-info/top_level.txt
 src/cti/__init__.py
 src/cti/main.py
 src/cti/api/__init__.py
+src/cti/api/async_client.py
 src/cti/api/client.py
 src/cti/logger/__init__.py
 src/cti/logger/logger.py

{clarity_api_sdk_python-0.1.8 → clarity_api_sdk_python-0.2.11}/src/cti/api/__init__.py

@@ -1,3 +1,4 @@
 """API client"""
 
+from .async_client import ClarityApiAsyncClient
 from .client import ClarityApiClient

clarity_api_sdk_python-0.2.11/src/cti/api/async_client.py

@@ -0,0 +1,127 @@
+"""Async client for clarity API"""
+
+import os
+import uuid
+
+from httpx import AsyncClient, HTTPStatusError, RequestError, Response, URL
+from httpx_auth import OAuth2ClientCredentials, OAuth2, TokenMemoryCache
+from httpx_retries import Retry, RetryTransport
+
+from cti.logger import get_logger
+
+logger = get_logger(__name__)
+OAuth2.token_cache = TokenMemoryCache()
+
+
+class ClarityApiAsyncClient(AsyncClient):
+    """Async 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.
+
+    The authorization token is cached and shared between each client instance to minimize
+    calls to the https://auth.sonarwiz.io/ keycloak server.
+    """
+
+    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"},
+        )
+
+    async def request(self, method: str, url: URL | str, **kwargs) -> Response:
+        """Make an async request to the Clarity API and handle exceptions. Using
+        this allows requests to be made concurrently and can provide significantly
+        improved performance. Use this to make multiple concurrent requests.
+
+        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 = await super().request(method, url, **kwargs)
+            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.8 → clarity_api_sdk_python-0.2.11}/src/cti/logger/logger.py

@@ -178,6 +178,7 @@ def _secret_redaction_processor(_, __, event_dict):
 def initialize_logger(
     initial_context: dict | None = None,
     external_logger_configurations: list[ExternalLoggerConfig] | None = None,
+    handlers: list[logging.Handler] | None = None,
 ) -> None:
     """Configures logging for the application using structlog.
 
@@ -204,15 +205,24 @@ def initialize_logger(
             bind to the context at the start of the application. These values
             will be included in every log message. Defaults to None.
         external_logger_configurations (list[ExternalLoggerConfig], optional): A list of configuration
+        handlers (list[logging.Handler], optional): A list of handlers to send log records to.
     """
     # Configure standard logging to be the sink for structlog.
     # The format="%(message)s" is important because structlog will format the log record
     # into a JSON string and pass it as the 'message'.
-    logging.basicConfig(
-        level=_level(),
-        format="%(message)s",
-        stream=sys.stdout,
-    )
+    formatter = logging.Formatter("%(message)s")
+
+    # Create a handler for stdout
+    stdout_handler = logging.StreamHandler(sys.stdout)
+    stdout_handler.setFormatter(formatter)
+
+    # Get the root logger and add handlers
+    root_logger = logging.getLogger()
+    root_logger.addHandler(stdout_handler)
+    for handler in handlers or []:
+        handler.setFormatter(formatter)
+        root_logger.addHandler(handler)
+    root_logger.setLevel(_level())
 
     # configure external loggers
     if external_logger_configurations:
@@ -273,10 +283,10 @@ def initialize_logger(
 def _level() -> str:
     """Get the log level for the logger.
 
-    The log level is determined by the `LOGGING_LEVEL` environment variable.
+    The log level is determined by the `LOG_LEVEL` environment variable.
     If the environment variable is not set, it defaults to "ERROR".
 
     Returns:
         str: The log level as a string (e.g., "DEBUG", "INFO", "ERROR").
     """
-    return os.environ.get("LOGGING_LEVEL", "ERROR")
+    return os.getenv("LOG_LEVEL", "INFO").upper()