# cribl_cloud_management_sdk_python
<!-- Start Summary [summary] -->
## Summary
Cribl.Cloud Public API: Serves as a public API for the Cribl.Cloud platform and powers the Speakeasy SDK
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [cribl_cloud_management_sdk_python](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#criblcloudmanagementsdkpython)
* [SDK Installation](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#sdk-installation)
* [IDE Support](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#ide-support)
* [SDK Example Usage](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#sdk-example-usage)
* [Authentication](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#authentication)
* [Available Resources and Operations](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#available-resources-and-operations)
* [Retries](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#retries)
* [Error Handling](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#error-handling)
* [Server Selection](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#server-selection)
* [Custom HTTP Client](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#custom-http-client)
* [Resource Management](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#resource-management)
* [Debugging](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#debugging)
<!-- End Table of Contents [toc] -->
<!-- Start SDK Installation [installation] -->
## SDK Installation
> [!NOTE]
> **Python version upgrade policy**
>
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
The SDK can be installed with either *pip* or *poetry* package managers.
### PIP
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
```bash
pip install cribl-mgmt-plane
```
### Poetry
*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
```bash
poetry add cribl-mgmt-plane
```
### Shell and script usage with `uv`
You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:
```shell
uvx --from cribl-mgmt-plane python
```
It's also possible to write a standalone Python script without needing to set up a whole project like so:
```python
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
# "cribl-mgmt-plane",
# ]
# ///
from cribl_mgmt_plane import CriblMgmtPlane
sdk = CriblMgmtPlane(
# SDK arguments
)
# Rest of script here...
```
Once that is saved to a file, you can run it with `uv run script.py` where
`script.py` can be replaced with the actual file name.
<!-- End SDK Installation [installation] -->
<!-- Start IDE Support [idesupport] -->
## IDE Support
### PyCharm
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```python
# Synchronous Example
from cribl_mgmt_plane import CriblMgmtPlane, models
import os
with CriblMgmtPlane(
security=models.Security(
client_oauth=models.SchemeClientOauth(
client_id=os.getenv("CRIBLMGMTPLANE_CLIENT_ID", ""),
client_secret=os.getenv("CRIBLMGMTPLANE_CLIENT_SECRET", ""),
token_url=os.getenv("CRIBLMGMTPLANE_TOKEN_URL", ""),
audience="https://publicapi.cribl.cloud",
),
),
) as cmp_client:
cmp_client.health.get()
# Use the SDK ...
```
</br>
The same SDK client can also be used to make asychronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from cribl_mgmt_plane import CriblMgmtPlane, models
import os
async def main():
async with CriblMgmtPlane(
security=models.Security(
client_oauth=models.SchemeClientOauth(
client_id=os.getenv("CRIBLMGMTPLANE_CLIENT_ID", ""),
client_secret=os.getenv("CRIBLMGMTPLANE_CLIENT_SECRET", ""),
token_url=os.getenv("CRIBLMGMTPLANE_TOKEN_URL", ""),
audience="https://publicapi.cribl.cloud",
),
),
) as cmp_client:
await cmp_client.health.get_async()
# Use the SDK ...
asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->
<!-- Start Authentication [security] -->
## Authentication
### Per-Client Security Schemes
This SDK supports the following security schemes globally:
| Name | Type | Scheme | Environment Variable |
| -------------- | ------ | ------------ | ----------------------------- |
| `client_oauth` | oauth2 | OAuth2 token | `CRIBLMGMTPLANE_CLIENT_OAUTH` |
| `bearer_auth` | http | HTTP Bearer | `CRIBLMGMTPLANE_BEARER_AUTH` |
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
```python
from cribl_mgmt_plane import CriblMgmtPlane, models
import os
with CriblMgmtPlane(
security=models.Security(
client_oauth=models.SchemeClientOauth(
client_id=os.getenv("CRIBLMGMTPLANE_CLIENT_ID", ""),
client_secret=os.getenv("CRIBLMGMTPLANE_CLIENT_SECRET", ""),
token_url=os.getenv("CRIBLMGMTPLANE_TOKEN_URL", ""),
audience="https://publicapi.cribl.cloud",
),
),
) as cmp_client:
cmp_client.health.get()
# Use the SDK ...
```
<!-- End Authentication [security] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
<details open>
<summary>Available methods</summary>
### [health](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/health/README.md)
* [get](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/health/README.md#get) - Get the health status of the application
### [workspaces](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md)
* [create](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md#create) - Create a new workspace
* [list](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md#list) - List all workspaces for an organization
* [update](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md#update) - Update an existing workspace
* [delete](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md#delete) - Delete a workspace
* [get](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md#get) - Get a specific workspace by ID
</details>
<!-- End Available Resources and Operations [operations] -->
<!-- Start Retries [retries] -->
## Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from cribl_mgmt_plane import CriblMgmtPlane, models
from cribl_mgmt_plane.utils import BackoffStrategy, RetryConfig
import os
with CriblMgmtPlane(
security=models.Security(
client_oauth=models.SchemeClientOauth(
client_id=os.getenv("CRIBLMGMTPLANE_CLIENT_ID", ""),
client_secret=os.getenv("CRIBLMGMTPLANE_CLIENT_SECRET", ""),
token_url=os.getenv("CRIBLMGMTPLANE_TOKEN_URL", ""),
audience="https://publicapi.cribl.cloud",
),
),
) as cmp_client:
cmp_client.health.get(,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
# Use the SDK ...
```
If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
from cribl_mgmt_plane import CriblMgmtPlane, models
from cribl_mgmt_plane.utils import BackoffStrategy, RetryConfig
import os
with CriblMgmtPlane(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
security=models.Security(
client_oauth=models.SchemeClientOauth(
client_id=os.getenv("CRIBLMGMTPLANE_CLIENT_ID", ""),
client_secret=os.getenv("CRIBLMGMTPLANE_CLIENT_SECRET", ""),
token_url=os.getenv("CRIBLMGMTPLANE_TOKEN_URL", ""),
audience="https://publicapi.cribl.cloud",
),
),
) as cmp_client:
cmp_client.health.get()
# Use the SDK ...
```
<!-- End Retries [retries] -->
<!-- Start Error Handling [errors] -->
## Error Handling
[`CriblMgmtPlaneError`](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/./src/cribl_mgmt_plane/errors/criblmgmtplaneerror.py) is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------ | ---------------- | ------------------------------------------------------ |
| `err.message` | `str` | Error message |
| `err.status_code` | `int` | HTTP response status code eg `404` |
| `err.headers` | `httpx.Headers` | HTTP response headers |
| `err.body` | `str` | HTTP body. Can be empty string if no body is returned. |
| `err.raw_response` | `httpx.Response` | Raw HTTP response |
### Example
```python
from cribl_mgmt_plane import CriblMgmtPlane, errors, models
import os
with CriblMgmtPlane(
security=models.Security(
client_oauth=models.SchemeClientOauth(
client_id=os.getenv("CRIBLMGMTPLANE_CLIENT_ID", ""),
client_secret=os.getenv("CRIBLMGMTPLANE_CLIENT_SECRET", ""),
token_url=os.getenv("CRIBLMGMTPLANE_TOKEN_URL", ""),
audience="https://publicapi.cribl.cloud",
),
),
) as cmp_client:
try:
cmp_client.health.get()
# Use the SDK ...
except errors.CriblMgmtPlaneError as e:
# The base class for HTTP error responses
print(e.message)
print(e.status_code)
print(e.body)
print(e.headers)
print(e.raw_response)
```
### Error Classes
**Primary error:**
* [`CriblMgmtPlaneError`](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/./src/cribl_mgmt_plane/errors/criblmgmtplaneerror.py): The base class for HTTP error responses.
<details><summary>Less common errors (5)</summary>
<br />
**Network errors:**
* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.
* [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.
* [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.
**Inherit from [`CriblMgmtPlaneError`](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/./src/cribl_mgmt_plane/errors/criblmgmtplaneerror.py)**:
* [`ResponseValidationError`](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/./src/cribl_mgmt_plane/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
</details>
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## Server Selection
### Override Server URL Per-Client
The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
from cribl_mgmt_plane import CriblMgmtPlane, models
import os
with CriblMgmtPlane(
server_url="https://publicapi.cribl.cloud",
security=models.Security(
client_oauth=models.SchemeClientOauth(
client_id=os.getenv("CRIBLMGMTPLANE_CLIENT_ID", ""),
client_secret=os.getenv("CRIBLMGMTPLANE_CLIENT_SECRET", ""),
token_url=os.getenv("CRIBLMGMTPLANE_TOKEN_URL", ""),
audience="https://publicapi.cribl.cloud",
),
),
) as cmp_client:
cmp_client.health.get()
# Use the SDK ...
```
<!-- End Server Selection [server] -->
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client
The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.
For example, you could specify a header for every request that this sdk makes as follows:
```python
from cribl_mgmt_plane import CriblMgmtPlane
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = CriblMgmtPlane(client=http_client)
```
or you could wrap the client with your own custom logic:
```python
from cribl_mgmt_plane import CriblMgmtPlane
from cribl_mgmt_plane.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = CriblMgmtPlane(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Resource Management [resource-management] -->
## Resource Management
The `CriblMgmtPlane` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
```python
from cribl_mgmt_plane import CriblMgmtPlane, models
import os
def main():
with CriblMgmtPlane(
security=models.Security(
client_oauth=models.SchemeClientOauth(
client_id=os.getenv("CRIBLMGMTPLANE_CLIENT_ID", ""),
client_secret=os.getenv("CRIBLMGMTPLANE_CLIENT_SECRET", ""),
token_url=os.getenv("CRIBLMGMTPLANE_TOKEN_URL", ""),
audience="https://publicapi.cribl.cloud",
),
),
) as cmp_client:
# Rest of application here...
# Or when using async:
async def amain():
async with CriblMgmtPlane(
security=models.Security(
client_oauth=models.SchemeClientOauth(
client_id=os.getenv("CRIBLMGMTPLANE_CLIENT_ID", ""),
client_secret=os.getenv("CRIBLMGMTPLANE_CLIENT_SECRET", ""),
token_url=os.getenv("CRIBLMGMTPLANE_TOKEN_URL", ""),
audience="https://publicapi.cribl.cloud",
),
),
) as cmp_client:
# Rest of application here...
```
<!-- End Resource Management [resource-management] -->
<!-- Start Debugging [debug] -->
## Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
```python
from cribl_mgmt_plane import CriblMgmtPlane
import logging
logging.basicConfig(level=logging.DEBUG)
s = CriblMgmtPlane(debug_logger=logging.getLogger("cribl_mgmt_plane"))
```
You can also enable a default debug logger by setting an environment variable `CRIBLMGMTPLANE_DEBUG` to true.
<!-- End Debugging [debug] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
Raw data
{
"_id": null,
"home_page": "https://github.com/criblio/cribl_cloud_management_sdk_python.git",
"name": "cribl-mgmt-plane",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.2",
"maintainer_email": null,
"keywords": null,
"author": "Speakeasy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/07/2d/e3054a5fd50f10fa5b66c3c924b65c4761f965c8348235c67ba3d917aa7b/cribl_mgmt_plane-0.0.8.tar.gz",
"platform": null,
"description": "# cribl_cloud_management_sdk_python\n<!-- Start Summary [summary] -->\n## Summary\n\nCribl.Cloud Public API: Serves as a public API for the Cribl.Cloud platform and powers the Speakeasy SDK\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n* [cribl_cloud_management_sdk_python](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#criblcloudmanagementsdkpython)\n * [SDK Installation](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#sdk-installation)\n * [IDE Support](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#ide-support)\n * [SDK Example Usage](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#sdk-example-usage)\n * [Authentication](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#authentication)\n * [Available Resources and Operations](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#available-resources-and-operations)\n * [Retries](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#retries)\n * [Error Handling](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#error-handling)\n * [Server Selection](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#server-selection)\n * [Custom HTTP Client](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#custom-http-client)\n * [Resource Management](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#resource-management)\n * [Debugging](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/#debugging)\n\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\n> [!NOTE]\n> **Python version upgrade policy**\n>\n> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.\n\nThe SDK can be installed with either *pip* or *poetry* package managers.\n\n### PIP\n\n*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.\n\n```bash\npip install cribl-mgmt-plane\n```\n\n### Poetry\n\n*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.\n\n```bash\npoetry add cribl-mgmt-plane\n```\n\n### Shell and script usage with `uv`\n\nYou can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:\n\n```shell\nuvx --from cribl-mgmt-plane python\n```\n\nIt's also possible to write a standalone Python script without needing to set up a whole project like so:\n\n```python\n#!/usr/bin/env -S uv run --script\n# /// script\n# requires-python = \">=3.9\"\n# dependencies = [\n# \"cribl-mgmt-plane\",\n# ]\n# ///\n\nfrom cribl_mgmt_plane import CriblMgmtPlane\n\nsdk = CriblMgmtPlane(\n # SDK arguments\n)\n\n# Rest of script here...\n```\n\nOnce that is saved to a file, you can run it with `uv run script.py` where\n`script.py` can be replaced with the actual file name.\n<!-- End SDK Installation [installation] -->\n\n<!-- Start IDE Support [idesupport] -->\n## IDE Support\n\n### PyCharm\n\nGenerally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.\n\n- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)\n<!-- End IDE Support [idesupport] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom cribl_mgmt_plane import CriblMgmtPlane, models\nimport os\n\n\nwith CriblMgmtPlane(\n security=models.Security(\n client_oauth=models.SchemeClientOauth(\n client_id=os.getenv(\"CRIBLMGMTPLANE_CLIENT_ID\", \"\"),\n client_secret=os.getenv(\"CRIBLMGMTPLANE_CLIENT_SECRET\", \"\"),\n token_url=os.getenv(\"CRIBLMGMTPLANE_TOKEN_URL\", \"\"),\n audience=\"https://publicapi.cribl.cloud\",\n ),\n ),\n) as cmp_client:\n\n cmp_client.health.get()\n\n # Use the SDK ...\n```\n\n</br>\n\nThe same SDK client can also be used to make asychronous requests by importing asyncio.\n```python\n# Asynchronous Example\nimport asyncio\nfrom cribl_mgmt_plane import CriblMgmtPlane, models\nimport os\n\nasync def main():\n\n async with CriblMgmtPlane(\n security=models.Security(\n client_oauth=models.SchemeClientOauth(\n client_id=os.getenv(\"CRIBLMGMTPLANE_CLIENT_ID\", \"\"),\n client_secret=os.getenv(\"CRIBLMGMTPLANE_CLIENT_SECRET\", \"\"),\n token_url=os.getenv(\"CRIBLMGMTPLANE_TOKEN_URL\", \"\"),\n audience=\"https://publicapi.cribl.cloud\",\n ),\n ),\n ) as cmp_client:\n\n await cmp_client.health.get_async()\n\n # Use the SDK ...\n\nasyncio.run(main())\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security schemes globally:\n\n| Name | Type | Scheme | Environment Variable |\n| -------------- | ------ | ------------ | ----------------------------- |\n| `client_oauth` | oauth2 | OAuth2 token | `CRIBLMGMTPLANE_CLIENT_OAUTH` |\n| `bearer_auth` | http | HTTP Bearer | `CRIBLMGMTPLANE_BEARER_AUTH` |\n\nYou can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:\n```python\nfrom cribl_mgmt_plane import CriblMgmtPlane, models\nimport os\n\n\nwith CriblMgmtPlane(\n security=models.Security(\n client_oauth=models.SchemeClientOauth(\n client_id=os.getenv(\"CRIBLMGMTPLANE_CLIENT_ID\", \"\"),\n client_secret=os.getenv(\"CRIBLMGMTPLANE_CLIENT_SECRET\", \"\"),\n token_url=os.getenv(\"CRIBLMGMTPLANE_TOKEN_URL\", \"\"),\n audience=\"https://publicapi.cribl.cloud\",\n ),\n ),\n) as cmp_client:\n\n cmp_client.health.get()\n\n # Use the SDK ...\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n<details open>\n<summary>Available methods</summary>\n\n\n### [health](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/health/README.md)\n\n* [get](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/health/README.md#get) - Get the health status of the application\n\n### [workspaces](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md)\n\n* [create](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md#create) - Create a new workspace\n* [list](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md#list) - List all workspaces for an organization\n* [update](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md#update) - Update an existing workspace\n* [delete](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md#delete) - Delete a workspace\n* [get](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/docs/sdks/workspaces/README.md#get) - Get a specific workspace by ID\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.\n\nTo change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:\n```python\nfrom cribl_mgmt_plane import CriblMgmtPlane, models\nfrom cribl_mgmt_plane.utils import BackoffStrategy, RetryConfig\nimport os\n\n\nwith CriblMgmtPlane(\n security=models.Security(\n client_oauth=models.SchemeClientOauth(\n client_id=os.getenv(\"CRIBLMGMTPLANE_CLIENT_ID\", \"\"),\n client_secret=os.getenv(\"CRIBLMGMTPLANE_CLIENT_SECRET\", \"\"),\n token_url=os.getenv(\"CRIBLMGMTPLANE_TOKEN_URL\", \"\"),\n audience=\"https://publicapi.cribl.cloud\",\n ),\n ),\n) as cmp_client:\n\n cmp_client.health.get(,\n RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\n # Use the SDK ...\n\n```\n\nIf you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:\n```python\nfrom cribl_mgmt_plane import CriblMgmtPlane, models\nfrom cribl_mgmt_plane.utils import BackoffStrategy, RetryConfig\nimport os\n\n\nwith CriblMgmtPlane(\n retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n security=models.Security(\n client_oauth=models.SchemeClientOauth(\n client_id=os.getenv(\"CRIBLMGMTPLANE_CLIENT_ID\", \"\"),\n client_secret=os.getenv(\"CRIBLMGMTPLANE_CLIENT_SECRET\", \"\"),\n token_url=os.getenv(\"CRIBLMGMTPLANE_TOKEN_URL\", \"\"),\n audience=\"https://publicapi.cribl.cloud\",\n ),\n ),\n) as cmp_client:\n\n cmp_client.health.get()\n\n # Use the SDK ...\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\n[`CriblMgmtPlaneError`](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/./src/cribl_mgmt_plane/errors/criblmgmtplaneerror.py) is the base class for all HTTP error responses. It has the following properties:\n\n| Property | Type | Description |\n| ------------------ | ---------------- | ------------------------------------------------------ |\n| `err.message` | `str` | Error message |\n| `err.status_code` | `int` | HTTP response status code eg `404` |\n| `err.headers` | `httpx.Headers` | HTTP response headers |\n| `err.body` | `str` | HTTP body. Can be empty string if no body is returned. |\n| `err.raw_response` | `httpx.Response` | Raw HTTP response |\n\n### Example\n```python\nfrom cribl_mgmt_plane import CriblMgmtPlane, errors, models\nimport os\n\n\nwith CriblMgmtPlane(\n security=models.Security(\n client_oauth=models.SchemeClientOauth(\n client_id=os.getenv(\"CRIBLMGMTPLANE_CLIENT_ID\", \"\"),\n client_secret=os.getenv(\"CRIBLMGMTPLANE_CLIENT_SECRET\", \"\"),\n token_url=os.getenv(\"CRIBLMGMTPLANE_TOKEN_URL\", \"\"),\n audience=\"https://publicapi.cribl.cloud\",\n ),\n ),\n) as cmp_client:\n\n try:\n\n cmp_client.health.get()\n\n # Use the SDK ...\n\n\n except errors.CriblMgmtPlaneError as e:\n # The base class for HTTP error responses\n print(e.message)\n print(e.status_code)\n print(e.body)\n print(e.headers)\n print(e.raw_response)\n\n```\n\n### Error Classes\n**Primary error:**\n* [`CriblMgmtPlaneError`](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/./src/cribl_mgmt_plane/errors/criblmgmtplaneerror.py): The base class for HTTP error responses.\n\n<details><summary>Less common errors (5)</summary>\n\n<br />\n\n**Network errors:**\n* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.\n * [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.\n * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.\n\n\n**Inherit from [`CriblMgmtPlaneError`](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/./src/cribl_mgmt_plane/errors/criblmgmtplaneerror.py)**:\n* [`ResponseValidationError`](https://github.com/criblio/cribl_cloud_management_sdk_python/blob/master/./src/cribl_mgmt_plane/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.\n\n</details>\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Override Server URL Per-Client\n\nThe default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:\n```python\nfrom cribl_mgmt_plane import CriblMgmtPlane, models\nimport os\n\n\nwith CriblMgmtPlane(\n server_url=\"https://publicapi.cribl.cloud\",\n security=models.Security(\n client_oauth=models.SchemeClientOauth(\n client_id=os.getenv(\"CRIBLMGMTPLANE_CLIENT_ID\", \"\"),\n client_secret=os.getenv(\"CRIBLMGMTPLANE_CLIENT_SECRET\", \"\"),\n token_url=os.getenv(\"CRIBLMGMTPLANE_TOKEN_URL\", \"\"),\n audience=\"https://publicapi.cribl.cloud\",\n ),\n ),\n) as cmp_client:\n\n cmp_client.health.get()\n\n # Use the SDK ...\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.\nDepending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.\nThis allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nfrom cribl_mgmt_plane import CriblMgmtPlane\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = CriblMgmtPlane(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom cribl_mgmt_plane import CriblMgmtPlane\nfrom cribl_mgmt_plane.httpclient import AsyncHttpClient\nimport httpx\n\nclass CustomClient(AsyncHttpClient):\n client: AsyncHttpClient\n\n def __init__(self, client: AsyncHttpClient):\n self.client = client\n\n async def send(\n self,\n request: httpx.Request,\n *,\n stream: bool = False,\n auth: Union[\n httpx._types.AuthTypes, httpx._client.UseClientDefault, None\n ] = httpx.USE_CLIENT_DEFAULT,\n follow_redirects: Union[\n bool, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n ) -> httpx.Response:\n request.headers[\"Client-Level-Header\"] = \"added by client\"\n\n return await self.client.send(\n request, stream=stream, auth=auth, follow_redirects=follow_redirects\n )\n\n def build_request(\n self,\n method: str,\n url: httpx._types.URLTypes,\n *,\n content: Optional[httpx._types.RequestContent] = None,\n data: Optional[httpx._types.RequestData] = None,\n files: Optional[httpx._types.RequestFiles] = None,\n json: Optional[Any] = None,\n params: Optional[httpx._types.QueryParamTypes] = None,\n headers: Optional[httpx._types.HeaderTypes] = None,\n cookies: Optional[httpx._types.CookieTypes] = None,\n timeout: Union[\n httpx._types.TimeoutTypes, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n extensions: Optional[httpx._types.RequestExtensions] = None,\n ) -> httpx.Request:\n return self.client.build_request(\n method,\n url,\n content=content,\n data=data,\n files=files,\n json=json,\n params=params,\n headers=headers,\n cookies=cookies,\n timeout=timeout,\n extensions=extensions,\n )\n\ns = CriblMgmtPlane(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Resource Management [resource-management] -->\n## Resource Management\n\nThe `CriblMgmtPlane` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.\n\n[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers\n\n```python\nfrom cribl_mgmt_plane import CriblMgmtPlane, models\nimport os\ndef main():\n\n with CriblMgmtPlane(\n security=models.Security(\n client_oauth=models.SchemeClientOauth(\n client_id=os.getenv(\"CRIBLMGMTPLANE_CLIENT_ID\", \"\"),\n client_secret=os.getenv(\"CRIBLMGMTPLANE_CLIENT_SECRET\", \"\"),\n token_url=os.getenv(\"CRIBLMGMTPLANE_TOKEN_URL\", \"\"),\n audience=\"https://publicapi.cribl.cloud\",\n ),\n ),\n ) as cmp_client:\n # Rest of application here...\n\n\n# Or when using async:\nasync def amain():\n\n async with CriblMgmtPlane(\n security=models.Security(\n client_oauth=models.SchemeClientOauth(\n client_id=os.getenv(\"CRIBLMGMTPLANE_CLIENT_ID\", \"\"),\n client_secret=os.getenv(\"CRIBLMGMTPLANE_CLIENT_SECRET\", \"\"),\n token_url=os.getenv(\"CRIBLMGMTPLANE_TOKEN_URL\", \"\"),\n audience=\"https://publicapi.cribl.cloud\",\n ),\n ),\n ) as cmp_client:\n # Rest of application here...\n```\n<!-- End Resource Management [resource-management] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass your own logger class directly into your SDK.\n```python\nfrom cribl_mgmt_plane import CriblMgmtPlane\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = CriblMgmtPlane(debug_logger=logging.getLogger(\"cribl_mgmt_plane\"))\n```\n\nYou can also enable a default debug logger by setting an environment variable `CRIBLMGMTPLANE_DEBUG` to true.\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Client SDK Generated by Speakeasy.",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/criblio/cribl_cloud_management_sdk_python.git",
"Repository": "https://github.com/criblio/cribl_cloud_management_sdk_python.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2eedb52ebe6260c6e738d7a702a9b12e22f0c0f3137c74dcc3a5ed370f309813",
"md5": "089630497e9531b3271bbc533e0895db",
"sha256": "9f7318bc95a5c2d93332e32b9b1fa8efeb93da75292f0986b9f1edd4d1f9d61f"
},
"downloads": -1,
"filename": "cribl_mgmt_plane-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "089630497e9531b3271bbc533e0895db",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.2",
"size": 54309,
"upload_time": "2025-08-14T08:16:56",
"upload_time_iso_8601": "2025-08-14T08:16:56.296824Z",
"url": "https://files.pythonhosted.org/packages/2e/ed/b52ebe6260c6e738d7a702a9b12e22f0c0f3137c74dcc3a5ed370f309813/cribl_mgmt_plane-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "072de3054a5fd50f10fa5b66c3c924b65c4761f965c8348235c67ba3d917aa7b",
"md5": "6770302d04e18dacac8a35f536ef6e90",
"sha256": "e466b12a4fb1e634a77b41d0d37870bc1d8a86f8dca29bdaf2ce7bcb1469fbe3"
},
"downloads": -1,
"filename": "cribl_mgmt_plane-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "6770302d04e18dacac8a35f536ef6e90",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.2",
"size": 37304,
"upload_time": "2025-08-14T08:16:57",
"upload_time_iso_8601": "2025-08-14T08:16:57.191597Z",
"url": "https://files.pythonhosted.org/packages/07/2d/e3054a5fd50f10fa5b66c3c924b65c4761f965c8348235c67ba3d917aa7b/cribl_mgmt_plane-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-14 08:16:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "criblio",
"github_project": "cribl_cloud_management_sdk_python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cribl-mgmt-plane"
}
JSON
