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

{clarity_api_sdk_python-0.2.12 → 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.12
+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

{clarity_api_sdk_python-0.2.12 → 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.12"
+version = "0.2.13"
 authors = [
   { name="Chesapeake Technology Inc.", email="support@chesapeaketech.com" },
 ]

{clarity_api_sdk_python-0.2.12 → 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.12
+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

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

@@ -7,6 +7,7 @@ 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

{clarity_api_sdk_python-0.2.12 → clarity_api_sdk_python-0.2.13}/src/cti/api/session.py

@@ -19,12 +19,11 @@ Example:
         asyncio.run(main())
 
     # In other modules
-    from cti.api.session import async_client
+    from cti.api.session import get_async_client
 
     async def fetch_data():
-        if async_client:
-            response = await async_client.get(...)
-            return response.json()
+        response = await get_async_client().get(...)
+        return response.json()
 """
 
 # pylint: disable=global-statement, unnecessary-dunder-call
@@ -32,7 +31,7 @@ Example:
 from cti.api.async_client import ClarityApiAsyncClient
 
 # The singleton instance, initially None.
-async_client: ClarityApiAsyncClient | None
+async_client: ClarityApiAsyncClient | None = None
 
 
 async def initialize_async_client() -> None:
@@ -46,6 +45,21 @@ async def initialize_async_client() -> 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.

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())