clarity-api-sdk-python 0.1.9__tar.gz → 0.2.12__tar.gz

{clarity_api_sdk_python-0.1.9 → clarity_api_sdk_python-0.2.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.1.9
+Version: 0.2.12
 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
@@ -77,3 +77,28 @@ logger_a.warning("This is a new warning message from logger_a.")
 logger_b.info("This info message from logger_b should NOT be visible.")
 logger_b.warning("This is warning message from logger_b")
 ```
+
+## API
+
+### Singleton async client
+
+```python
+import asyncio
+from cti.api.session import initialize_async_client, close_async_client
+
+async def main():
+    await initialize_async_client()
+    # ... your application logic ...
+    await close_async_client()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+
+# In other modules
+from cti.api.session import async_client
+
+async def fetch_data():
+    if async_client:
+        response = await async_client.get(...)
+        return response.json()
+```

{clarity_api_sdk_python-0.1.9 → clarity_api_sdk_python-0.2.12}/README.md

@@ -55,3 +55,28 @@ logger_a.warning("This is a new warning message from logger_a.")
 logger_b.info("This info message from logger_b should NOT be visible.")
 logger_b.warning("This is warning message from logger_b")
 ```
+
+## API
+
+### Singleton async client
+
+```python
+import asyncio
+from cti.api.session import initialize_async_client, close_async_client
+
+async def main():
+    await initialize_async_client()
+    # ... your application logic ...
+    await close_async_client()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+
+# In other modules
+from cti.api.session import async_client
+
+async def fetch_data():
+    if async_client:
+        response = await async_client.get(...)
+        return response.json()
+```

{clarity_api_sdk_python-0.1.9 → clarity_api_sdk_python-0.2.12}/pyproject.toml

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

{clarity_api_sdk_python-0.1.9 → clarity_api_sdk_python-0.2.12}/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.9
+Version: 0.2.12
 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
@@ -77,3 +77,28 @@ logger_a.warning("This is a new warning message from logger_a.")
 logger_b.info("This info message from logger_b should NOT be visible.")
 logger_b.warning("This is warning message from logger_b")
 ```
+
+## API
+
+### Singleton async client
+
+```python
+import asyncio
+from cti.api.session import initialize_async_client, close_async_client
+
+async def main():
+    await initialize_async_client()
+    # ... your application logic ...
+    await close_async_client()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+
+# In other modules
+from cti.api.session import async_client
+
+async def fetch_data():
+    if async_client:
+        response = await async_client.get(...)
+        return response.json()
+```

{clarity_api_sdk_python-0.1.9 → clarity_api_sdk_python-0.2.12}/src/clarity_api_sdk_python.egg-info/SOURCES.txt

@@ -8,6 +8,8 @@ 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/api/session.py
 src/cti/logger/__init__.py
 src/cti/logger/logger.py

clarity_api_sdk_python-0.2.12/src/cti/api/__init__.py

@@ -0,0 +1,5 @@
+"""API client"""
+
+from .async_client import ClarityApiAsyncClient
+from .client import ClarityApiClient
+from .session import async_client, initialize_async_client, close_async_client

clarity_api_sdk_python-0.2.12/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.2.12/src/cti/api/session.py

@@ -0,0 +1,59 @@
+"""Provides a shared, singleton instance of the ClarityApiAsyncClient.
+
+This module allows for a single, reusable async client to be initialized
+and accessed throughout the application, promoting connection reuse and
+efficiency. The client should be initialized at application startup
+and closed gracefully on shutdown.
+
+Example:
+    # In your main application entry point
+    import asyncio
+    from cti.api.session import initialize_async_client, close_async_client
+
+    async def main():
+        await initialize_async_client()
+        # ... your application logic ...
+        await close_async_client()
+
+    if __name__ == "__main__":
+        asyncio.run(main())
+
+    # In other modules
+    from cti.api.session import async_client
+
+    async def fetch_data():
+        if async_client:
+            response = await async_client.get(...)
+            return response.json()
+"""
+
+# pylint: disable=global-statement, unnecessary-dunder-call
+
+from cti.api.async_client import ClarityApiAsyncClient
+
+# The singleton instance, initially None.
+async_client: ClarityApiAsyncClient | None
+
+
+async def initialize_async_client() -> None:
+    """Initializes the shared ClarityApiAsyncClient instance.
+
+    If the client is already initialized, this function does nothing.
+    This function should be awaited at application startup.
+    """
+    global async_client
+    if async_client is None:
+        async_client = ClarityApiAsyncClient()
+        await async_client.__aenter__()
+
+
+async def close_async_client() -> None:
+    """Closes the shared ClarityApiAsyncClient instance.
+
+    This function should be awaited at application shutdown to ensure
+    the underlying connection pool is closed gracefully.
+    """
+    global async_client
+    if async_client:
+        await async_client.__aexit__(None, None, None)
+        async_client = None

clarity_api_sdk_python-0.1.9/src/cti/api/__init__.py

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