liminal-sdk-python 2024.3.4__tar.gz → 2024.4.0__tar.gz

{liminal_sdk_python-2024.3.4 → liminal_sdk_python-2024.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: liminal-sdk-python
-Version: 2024.3.4
+Version: 2024.4.0
 Summary: The Liminal SDK for Python
 Home-page: https://github.com/liminal-ai-security/liminal-sdk-python
 License: Apache-2.0
@@ -17,7 +17,7 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Dist: httpx (==0.27.0)
 Requires-Dist: mashumaro (==3.12)
-Requires-Dist: msal (==1.27.0)
+Requires-Dist: msal (==1.28.0)
 Project-URL: Bug Tracker, https://github.com/liminal-ai-security/liminal-sdk-python/issues
 Project-URL: Changelog, https://github.com/liminal-ai-security/liminal-sdk-python/releases
 Project-URL: Repository, https://github.com/liminal-ai-security/liminal-sdk-python
@@ -25,6 +25,7 @@ Description-Content-Type: text/markdown
 
 # Liminal Python SDK
 
+[![CI][ci-badge]][ci]
 [![PyPI][pypi-badge]][pypi]
 [![Version][version-badge]][version]
 [![License][license-badge]][license]
@@ -34,7 +35,19 @@ for interacting with the Liminal API.
 
 - [Installation](#installation)
 - [Python Versions](#python-versions)
-- [Usage](#usage)
+- [Quickstart](#quickstart)
+- [Initial Authentication](#initial-authentication)
+  - [Microsoft Entra ID](#microsoft-entra-id)
+    - [Device Code Flow](#device-code-flow)
+- [Ongoing Authentication](#ongoing-authentication)
+  - [Manually Interacting with the Refresh Token](#manually-interacting-with-the-refresh-token)
+  - [Creating a Liminal Client from a Stored Refresh Token](#creating-a-liminal-client-from-a-stored-refresh-token)
+- [Endpoints](#endpoints)
+  - [Getting Model Instances](#getting-model-instances)
+  - [Managing Threads](#managing-threads)
+  - [Submitting Prompts](#submitting-prompts)
+- [Connection Pooling](#connection-pooling)
+- [Running Examples](#running-examples)
 - [Contributing](#contributing)
 
 # Installation
@@ -59,16 +72,16 @@ API object is easy:
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
     """Create the aiohttp session and run the example."""
     # Create an auth provider to authenticate the user:
-    microsoft_auth_provider = MicrosoftAuthProvider("<TENANT_ID>", "<CLIENT_ID>")
+    auth_provider = DeviceCodeFlowProvider("<TENANT_ID>", "<CLIENT_ID>")
 
     # Create the liminal SDK instance:
-    liminal = Client(microsoft_auth_provider, "<LIMINAL_API_SERVER_URL>")
+    liminal = Client(auth_provider, "<LIMINAL_API_SERVER_URL>")
 
 
 asyncio.run(main())
@@ -86,13 +99,15 @@ the following auth providers are supported:
 
 ## Microsoft Entra ID
 
-Liminal authenticates with Microsoft Entra ID via an
+### Device Code Flow
+
+This authentication process with Microsoft Entra ID involves an
 [OAuth 2.0 Device Authorization Grant][oauth-device-auth-grant]. This flow requires you
 to start your app, retrieve a device code from the logs produced by this SDK, and
 provide that code to Microsoft via a web browser. Once you complete the login process,
 the SDK will be authenticated for use with your Liminal instance.
 
-### Finding your Entra ID Tenant and Client IDs
+To authenticate with this flow, you will need an Entra ID client and tenant ID:
 
 - Log into your [Azure portal][azure-portal].
 - Navigate to `Microsoft Entra ID`.
@@ -101,8 +116,6 @@ the SDK will be authenticated for use with your Liminal instance.
 - In the `Overview` of the registration, look for the `Application (client) ID` and
   `Directory (tenant) ID` values.
 
-### Authenticating Against Entra ID
-
 With a client ID and tenant ID, you can create a Liminal client object and authenticate
 it:
 
@@ -110,16 +123,16 @@ it:
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
     """Create the aiohttp session and run the example."""
     # Create an auth provider to authenticate the user:
-    microsoft_auth_provider = MicrosoftAuthProvider("<TENANT_ID>", "<CLIENT_ID>")
+    auth_provider = DeviceCodeFlowProvider("<TENANT_ID>", "<CLIENT_ID>")
 
     # Create the liminal SDK instance and authenticate it:
-    liminal = Client(microsoft_auth_provider, "<LIMINAL_API_SERVER_URL>")
+    liminal = Client(auth_provider, "<LIMINAL_API_SERVER_URL>")
     await liminal.authenticate_from_auth_provider()
 
 
@@ -161,13 +174,13 @@ callback at any time.
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
     """Create the aiohttp session and run the example."""
     # Create an auth provider to authenticate the user:
-    microsoft_auth_provider = MicrosoftAuthProvider("<TENANT_ID>", "<CLIENT_ID>")
+    auth_provider = DeviceCodeFlowProvider("<TENANT_ID>", "<CLIENT_ID>")
 
     # Create the liminal SDK instance and authenticate it:
     liminal = Client(microsoft_auth_provider, "<LIMINAL_API_SERVER_URL>")
@@ -189,7 +202,32 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
-# Getting Model Instances
+## Creating a Liminal Client from a Stored Refresh Token
+
+Assuming you have a stored refresh token (collected from the callback process shown
+above), it is simple to create a new Limina client using that token:
+
+```python
+import asyncio
+
+from liminal import Client
+
+
+async def main() -> None:
+    """Create the aiohttp session and run the example."""
+    # Retrieve your stored refresh_token:
+    refresh_token = "12345"
+
+    # Create the client:
+    liminal = await client.authenticate_from_refresh_token(refresh_token=refresh_token)
+
+
+asyncio.run(main())
+```
+
+# Endpoints
+
+## Getting Model Instances
 
 Every LLM instance connected in the Liminal admin dashboard is referred to as a "model
 instance." The SDK provides several methods to interact with model instances:
@@ -198,7 +236,7 @@ instance." The SDK provides several methods to interact with model instances:
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
@@ -216,7 +254,7 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
-# Managing Threads
+## Managing Threads
 
 Threads are conversations with an LLM instance:
 
@@ -224,7 +262,7 @@ Threads are conversations with an LLM instance:
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
@@ -245,15 +283,11 @@ async def main() -> None:
     thread = await liminal.thread.create(model_instance.id, "New Thread")
     # >>> Thread(...)
 
-    # Get the "de-identified" (containing sensitive data) context history for a thread:
-    thread = await liminal.thread.get_deidentified_context_history(model_instance.id)
-    # >>> [DeidentifiedToken(...), DeidentifiedToken(...), DeidentifiedToken(...)]
-
 
 asyncio.run(main())
 ```
 
-# Submitting Prompts
+## Submitting Prompts
 
 Submitting prompts is easy:
 
@@ -261,38 +295,49 @@ Submitting prompts is easy:
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
     # Assuming you have an authenticated `liminal` object:
 
-    # Prompt operations require a thread:
+    # Prompt operations require a model instance:
+    model_instance = await liminal.llm.get_model_instance(model_instance_name)
+
+    # Prompt operations optionally take an existing thread:
     thread = await liminal.thread.get_by_id(123)
     # >>> Thread(...)
 
     # Analayze a prompt for sensitive info:
-    findings = await liminal.prompt.analyze(thread.id)
+    findings = await liminal.prompt.analyze(
+        model_instance.id, "Here is a sensitive prompt"
+    )
     # >>> AnalyzeResponse(...)
 
     # Cleanse input text by applying the policies defined in the Liminal admin
     # dashboard. You can optionally provide existing analysis finidings; if not
     # provided, analyze is # called automatically):
     cleansed = await liminal.prompt.cleanse(
-        thread.id, "Here is a sensitive prompt", findings=findings
+        model_instance.id,
+        "Here is a sensitive prompt",
+        findings=findings,
+        thread_id=thread.id,
     )
     # >>> CleanseResponse(...)
 
     # Submit a prompt to an LLM, cleansing it in the process (once again, providing optional
     # findings):
     response = await liminal.prompt.submit(
-        thread.id, "Here is a sensitive prompt", findings=findings
+        model_instance.id,
+        "Here is a sensitive prompt",
+        findings=findings,
+        thread_id=thread.id,
     )
-    # >>> ProcessResponse(...)
+    # >>> SubmitResponse(...)
 
     # Rehydrate a response with sensitive data:
     hydrated = await liminal.prompt.hydrate(
-        thread.id, "Here is a response to rehdyrate"
+        model_instance.id, "Here is a response to rehdyrate", thread_id=thread.id
     )
     # >>> HydrateResponse(...)
 
@@ -300,6 +345,40 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
+# Connection Pooling
+
+By default, the library creates a new connection to the Liminal API server with each
+coroutine. If you are calling a large number of coroutines (or merely want to squeeze
+out every second of runtime savings possible), an [`httpx`][httpx] `AsyncClient` can be
+used for connection pooling:
+
+```python
+import asyncio
+
+from liminal import Client
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
+
+
+async def main() -> None:
+    # Create an auth provider to authenticate the user:
+    microsoft_auth_provider = MicrosoftAuthProvider("<TENANT_ID>", "<CLIENT_ID>")
+
+    # Create the liminal SDK instance with a shared HTTPX AsyncClient:
+    async with httpx.AsyncClient() as client:
+        liminal = Client(
+            microsoft_auth_provider, "<LIMINAL_API_SERVER_URL>", httpx_client=client
+        )
+
+        # Get to work!
+        # ...
+
+
+asyncio.run(main())
+```
+
+Check out the examples, the tests, and the source files themselves for method
+signatures and more examples.
+
 # Running Examples
 
 You can see examples of how to use this SDK via the [`examples`][examples] folder in
@@ -322,7 +401,7 @@ Thanks to all of [our contributors][contributors] so far!
 2. [Fork the repository][fork].
 3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv`
 4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate`
-5. Install the dev environment: `script/setup`
+5. Install the dev environment: `./scripts/setup.sh`
 6. Code your new feature or bug fix on a new branch.
 7. Write tests that cover your new functionality.
 8. Run tests and ensure 100% code coverage: `poetry run pytest --cov liminal tests`
@@ -330,10 +409,12 @@ Thanks to all of [our contributors][contributors] so far!
 10. Submit a pull request!
 
 [azure-portal]: https://portal.azure.com
+[ci-badge]: https://img.shields.io/github/actions/workflow/status/liminal-ai-security/liminal-sdk-python/test.yml
 [ci]: https://github.com/liminal-ai-security/liminal-sdk-python/actions
 [contributors]: https://github.com/liminal-ai-security/liminal-sdk-python/graphs/contributors
 [examples]: https://github.com/liminal-ai-security/liminal-sdk-python/tree/development/examples
 [fork]: https://github.com/liminal-ai-security/liminal-sdk-python/fork
+[httpx]: https://www.python-httpx.org/
 [issues]: https://github.com/liminal-ai-security/liminal-sdk-python/issues
 [license-badge]: https://img.shields.io/pypi/l/liminal-sdk-python.svg
 [license]: https://github.com/liminal-ai-security/liminal-sdk-python/blob/main/LICENSE

{liminal_sdk_python-2024.3.4 → liminal_sdk_python-2024.4.0}/README.md

@@ -1,5 +1,6 @@
 # Liminal Python SDK
 
+[![CI][ci-badge]][ci]
 [![PyPI][pypi-badge]][pypi]
 [![Version][version-badge]][version]
 [![License][license-badge]][license]
@@ -9,7 +10,19 @@ for interacting with the Liminal API.
 
 - [Installation](#installation)
 - [Python Versions](#python-versions)
-- [Usage](#usage)
+- [Quickstart](#quickstart)
+- [Initial Authentication](#initial-authentication)
+  - [Microsoft Entra ID](#microsoft-entra-id)
+    - [Device Code Flow](#device-code-flow)
+- [Ongoing Authentication](#ongoing-authentication)
+  - [Manually Interacting with the Refresh Token](#manually-interacting-with-the-refresh-token)
+  - [Creating a Liminal Client from a Stored Refresh Token](#creating-a-liminal-client-from-a-stored-refresh-token)
+- [Endpoints](#endpoints)
+  - [Getting Model Instances](#getting-model-instances)
+  - [Managing Threads](#managing-threads)
+  - [Submitting Prompts](#submitting-prompts)
+- [Connection Pooling](#connection-pooling)
+- [Running Examples](#running-examples)
 - [Contributing](#contributing)
 
 # Installation
@@ -34,16 +47,16 @@ API object is easy:
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
     """Create the aiohttp session and run the example."""
     # Create an auth provider to authenticate the user:
-    microsoft_auth_provider = MicrosoftAuthProvider("<TENANT_ID>", "<CLIENT_ID>")
+    auth_provider = DeviceCodeFlowProvider("<TENANT_ID>", "<CLIENT_ID>")
 
     # Create the liminal SDK instance:
-    liminal = Client(microsoft_auth_provider, "<LIMINAL_API_SERVER_URL>")
+    liminal = Client(auth_provider, "<LIMINAL_API_SERVER_URL>")
 
 
 asyncio.run(main())
@@ -61,13 +74,15 @@ the following auth providers are supported:
 
 ## Microsoft Entra ID
 
-Liminal authenticates with Microsoft Entra ID via an
+### Device Code Flow
+
+This authentication process with Microsoft Entra ID involves an
 [OAuth 2.0 Device Authorization Grant][oauth-device-auth-grant]. This flow requires you
 to start your app, retrieve a device code from the logs produced by this SDK, and
 provide that code to Microsoft via a web browser. Once you complete the login process,
 the SDK will be authenticated for use with your Liminal instance.
 
-### Finding your Entra ID Tenant and Client IDs
+To authenticate with this flow, you will need an Entra ID client and tenant ID:
 
 - Log into your [Azure portal][azure-portal].
 - Navigate to `Microsoft Entra ID`.
@@ -76,8 +91,6 @@ the SDK will be authenticated for use with your Liminal instance.
 - In the `Overview` of the registration, look for the `Application (client) ID` and
   `Directory (tenant) ID` values.
 
-### Authenticating Against Entra ID
-
 With a client ID and tenant ID, you can create a Liminal client object and authenticate
 it:
 
@@ -85,16 +98,16 @@ it:
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
     """Create the aiohttp session and run the example."""
     # Create an auth provider to authenticate the user:
-    microsoft_auth_provider = MicrosoftAuthProvider("<TENANT_ID>", "<CLIENT_ID>")
+    auth_provider = DeviceCodeFlowProvider("<TENANT_ID>", "<CLIENT_ID>")
 
     # Create the liminal SDK instance and authenticate it:
-    liminal = Client(microsoft_auth_provider, "<LIMINAL_API_SERVER_URL>")
+    liminal = Client(auth_provider, "<LIMINAL_API_SERVER_URL>")
     await liminal.authenticate_from_auth_provider()
 
 
@@ -136,13 +149,13 @@ callback at any time.
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
     """Create the aiohttp session and run the example."""
     # Create an auth provider to authenticate the user:
-    microsoft_auth_provider = MicrosoftAuthProvider("<TENANT_ID>", "<CLIENT_ID>")
+    auth_provider = DeviceCodeFlowProvider("<TENANT_ID>", "<CLIENT_ID>")
 
     # Create the liminal SDK instance and authenticate it:
     liminal = Client(microsoft_auth_provider, "<LIMINAL_API_SERVER_URL>")
@@ -164,7 +177,32 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
-# Getting Model Instances
+## Creating a Liminal Client from a Stored Refresh Token
+
+Assuming you have a stored refresh token (collected from the callback process shown
+above), it is simple to create a new Limina client using that token:
+
+```python
+import asyncio
+
+from liminal import Client
+
+
+async def main() -> None:
+    """Create the aiohttp session and run the example."""
+    # Retrieve your stored refresh_token:
+    refresh_token = "12345"
+
+    # Create the client:
+    liminal = await client.authenticate_from_refresh_token(refresh_token=refresh_token)
+
+
+asyncio.run(main())
+```
+
+# Endpoints
+
+## Getting Model Instances
 
 Every LLM instance connected in the Liminal admin dashboard is referred to as a "model
 instance." The SDK provides several methods to interact with model instances:
@@ -173,7 +211,7 @@ instance." The SDK provides several methods to interact with model instances:
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
@@ -191,7 +229,7 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
-# Managing Threads
+## Managing Threads
 
 Threads are conversations with an LLM instance:
 
@@ -199,7 +237,7 @@ Threads are conversations with an LLM instance:
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
@@ -220,15 +258,11 @@ async def main() -> None:
     thread = await liminal.thread.create(model_instance.id, "New Thread")
     # >>> Thread(...)
 
-    # Get the "de-identified" (containing sensitive data) context history for a thread:
-    thread = await liminal.thread.get_deidentified_context_history(model_instance.id)
-    # >>> [DeidentifiedToken(...), DeidentifiedToken(...), DeidentifiedToken(...)]
-
 
 asyncio.run(main())
 ```
 
-# Submitting Prompts
+## Submitting Prompts
 
 Submitting prompts is easy:
 
@@ -236,38 +270,49 @@ Submitting prompts is easy:
 import asyncio
 
 from liminal import Client
-from liminal.endpoints.auth import MicrosoftAuthProvider
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
 
 
 async def main() -> None:
     # Assuming you have an authenticated `liminal` object:
 
-    # Prompt operations require a thread:
+    # Prompt operations require a model instance:
+    model_instance = await liminal.llm.get_model_instance(model_instance_name)
+
+    # Prompt operations optionally take an existing thread:
     thread = await liminal.thread.get_by_id(123)
     # >>> Thread(...)
 
     # Analayze a prompt for sensitive info:
-    findings = await liminal.prompt.analyze(thread.id)
+    findings = await liminal.prompt.analyze(
+        model_instance.id, "Here is a sensitive prompt"
+    )
     # >>> AnalyzeResponse(...)
 
     # Cleanse input text by applying the policies defined in the Liminal admin
     # dashboard. You can optionally provide existing analysis finidings; if not
     # provided, analyze is # called automatically):
     cleansed = await liminal.prompt.cleanse(
-        thread.id, "Here is a sensitive prompt", findings=findings
+        model_instance.id,
+        "Here is a sensitive prompt",
+        findings=findings,
+        thread_id=thread.id,
     )
     # >>> CleanseResponse(...)
 
     # Submit a prompt to an LLM, cleansing it in the process (once again, providing optional
     # findings):
     response = await liminal.prompt.submit(
-        thread.id, "Here is a sensitive prompt", findings=findings
+        model_instance.id,
+        "Here is a sensitive prompt",
+        findings=findings,
+        thread_id=thread.id,
     )
-    # >>> ProcessResponse(...)
+    # >>> SubmitResponse(...)
 
     # Rehydrate a response with sensitive data:
     hydrated = await liminal.prompt.hydrate(
-        thread.id, "Here is a response to rehdyrate"
+        model_instance.id, "Here is a response to rehdyrate", thread_id=thread.id
     )
     # >>> HydrateResponse(...)
 
@@ -275,6 +320,40 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
+# Connection Pooling
+
+By default, the library creates a new connection to the Liminal API server with each
+coroutine. If you are calling a large number of coroutines (or merely want to squeeze
+out every second of runtime savings possible), an [`httpx`][httpx] `AsyncClient` can be
+used for connection pooling:
+
+```python
+import asyncio
+
+from liminal import Client
+from liminal.auth.microsoft.device_code_flow import DeviceCodeFlowProvider
+
+
+async def main() -> None:
+    # Create an auth provider to authenticate the user:
+    microsoft_auth_provider = MicrosoftAuthProvider("<TENANT_ID>", "<CLIENT_ID>")
+
+    # Create the liminal SDK instance with a shared HTTPX AsyncClient:
+    async with httpx.AsyncClient() as client:
+        liminal = Client(
+            microsoft_auth_provider, "<LIMINAL_API_SERVER_URL>", httpx_client=client
+        )
+
+        # Get to work!
+        # ...
+
+
+asyncio.run(main())
+```
+
+Check out the examples, the tests, and the source files themselves for method
+signatures and more examples.
+
 # Running Examples
 
 You can see examples of how to use this SDK via the [`examples`][examples] folder in
@@ -297,7 +376,7 @@ Thanks to all of [our contributors][contributors] so far!
 2. [Fork the repository][fork].
 3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv`
 4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate`
-5. Install the dev environment: `script/setup`
+5. Install the dev environment: `./scripts/setup.sh`
 6. Code your new feature or bug fix on a new branch.
 7. Write tests that cover your new functionality.
 8. Run tests and ensure 100% code coverage: `poetry run pytest --cov liminal tests`
@@ -305,10 +384,12 @@ Thanks to all of [our contributors][contributors] so far!
 10. Submit a pull request!
 
 [azure-portal]: https://portal.azure.com
+[ci-badge]: https://img.shields.io/github/actions/workflow/status/liminal-ai-security/liminal-sdk-python/test.yml
 [ci]: https://github.com/liminal-ai-security/liminal-sdk-python/actions
 [contributors]: https://github.com/liminal-ai-security/liminal-sdk-python/graphs/contributors
 [examples]: https://github.com/liminal-ai-security/liminal-sdk-python/tree/development/examples
 [fork]: https://github.com/liminal-ai-security/liminal-sdk-python/fork
+[httpx]: https://www.python-httpx.org/
 [issues]: https://github.com/liminal-ai-security/liminal-sdk-python/issues
 [license-badge]: https://img.shields.io/pypi/l/liminal-sdk-python.svg
 [license]: https://github.com/liminal-ai-security/liminal-sdk-python/blob/main/LICENSE

liminal_sdk_python-2024.4.0/liminal/auth/__init__.py

@@ -0,0 +1,18 @@
+"""Define auth providers."""
+
+
+class AuthProvider:  # pylint: disable=too-few-public-methods
+    """Define an auth provider abstract base class."""
+
+    async def get_access_token(self) -> str:
+        """Retrieve an access token from the auth provider.
+
+        The working principle here is that the auth provider will return an access
+        token that can be used to authenticate with the Liminal API server.
+
+        Returns
+        -------
+            The access token.
+
+        """
+        raise NotImplementedError

liminal_sdk_python-2024.4.0/liminal/auth/microsoft/__init__.py

@@ -0,0 +1 @@
+"""Define Microsoft providers."""