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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.2.11
+Version: 0.2.13
 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.2.11 → clarity_api_sdk_python-0.2.13}/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.2.11 → clarity_api_sdk_python-0.2.13}/pyproject.toml

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.2.11
+Version: 0.2.13
 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.2.11 → clarity_api_sdk_python-0.2.13}/src/clarity_api_sdk_python.egg-info/SOURCES.txt

@@ -7,8 +7,10 @@ src/clarity_api_sdk_python.egg-info/requires.txt
 src/clarity_api_sdk_python.egg-info/top_level.txt
 src/cti/__init__.py
 src/cti/main.py
+src/cti/main_api.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.11 → clarity_api_sdk_python-0.2.13}/src/cti/api/__init__.py

@@ -2,3 +2,4 @@
 
 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.13/src/cti/api/session.py

@@ -0,0 +1,73 @@
+"""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 get_async_client
+
+    async def fetch_data():
+        response = await get_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 = 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__()
+
+def get_async_client() -> ClarityApiAsyncClient:
+    """Returns the shared ClarityApiAsyncClient instance.
+
+    If the client is not initialized, this function initializes it first.
+
+    Returns:
+        ClarityApiAsyncClient: The shared ClarityApiAsyncClient instance.
+
+    Raises:
+        ValueError: If initialize_async_client() has not been called first.
+    """
+    if async_client is None:
+        raise ValueError("initialize_async_client() must be called first to initialize client.")
+    return async_client
+
+
+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.2.13/src/cti/main_api.py

@@ -0,0 +1,19 @@
+"""Example"""
+
+import asyncio
+
+from cti.api.session import get_async_client, close_async_client, initialize_async_client
+
+async def main():
+    """Example of using the Clarity API asynchronously
+    """
+    try:
+        await initialize_async_client()
+        client = get_async_client()
+        response = await client.get(url="/api/v1/status")
+        print(response.json())
+    finally:
+        await close_async_client()
+
+if __name__ == "__main__":
+    asyncio.run(main())