Developer-friendly & type-safe Python SDK specifically catered to leverage sudo API.
- sudo
- Development
Note
Python version upgrade policy
Once a Python version reaches its official end of life date, 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 is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install sudo-pythonPoetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.
poetry add sudo-pythonYou can use this SDK in a Python shell with uv and the uvx command that comes with it like so:
uvx --from sudo pythonIt's also possible to write a standalone Python script without needing to set up a whole project like so:
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
# "sudo",
# ]
# ///
from sudo import Sudo
sdk = Sudo(
# 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.
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.
# Synchronous Example
import os
from sudo import Sudo
with Sudo(
server_url="https://api.example.com",
api_key=os.getenv("SUDO_API_KEY", ""),
) as s_client:
res = s_client.system.health_check()
# Handle response
print(res)The same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
import os
from sudo import Sudo
async def main():
async with Sudo(
server_url="https://api.example.com",
api_key=os.getenv("SUDO_API_KEY", ""),
) as s_client:
res = await s_client.system.health_check_async()
# Handle response
print(res)
asyncio.run(main())This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
api_key |
http | HTTP Bearer | SUDO_API_KEY |
To authenticate with the API the api_key parameter must be set when initializing the SDK client instance. For example:
import os
from sudo import Sudo
with Sudo(
server_url="https://api.example.com",
api_key=os.getenv("SUDO_API_KEY", ""),
) as s_client:
res = s_client.system.health_check()
# Handle response
print(res)Available methods
- list_chat_completions - [OpenAI Only] Get a list of saved Chat Completions. Only Chat Completions that have been stored with the
storeparameter set to true will be returned. - create - Create a model response for the given string of prompts.
- create_streaming - Create a streaming model response for the given string of prompts using server-sent events.
- get_chat_completion - [OpenAI Only] Get a Chat Completion. Only Chat Completions that have been stored with the
storeparameter set to true will be returned. - update_chat_completion - [OpenAI Only] Update a Chat Completion with some metadata. Only Chat Completions that have been stored with the
storeparameter set to true will be returned. - delete_chat_completion - [OpenAI Only] Delete a stored Chat Completion. Only Chat Completions that have been stored with the
storeparameter set to true will be returned. - get_chat_completion_messages - [OpenAI Only] Get the array of messages for a saved Chat Completion. Only Chat Completions that have been stored with the
storeparameter set to true will be returned.
- health_check - Check if the Sudo API and backend infrastructure are health and ready to accept connections.
- get_supported_models - Get a list of all AI models supported in the Sudo API.
Server-sent events are used to stream content from certain
operations. These operations will expose the stream as Generator that
can be consumed using a simple for loop. The loop will
terminate when the server no longer has any events to send and closes the
underlying connection.
The stream is also a Context Manager and can be used with the with statement and will close the
underlying connection when the context is exited.
import os
from sudo import Sudo
with Sudo(
server_url="https://api.example.com",
api_key=os.getenv("SUDO_API_KEY", ""),
) as s_client:
res = s_client.router.create_streaming(messages=[
{
"content": "You are a helpful assistant.",
"role": "developer",
},
{
"content": "Hello! How are you?",
"role": "user",
},
], model="gpt-4o")
with res as event_stream:
for chunk in event_stream:
# Access the chunk data
if chunk.data and chunk.data.choices:
for choice in chunk.data.choices:
if choice.delta and choice.delta.content:
print(choice.delta.content, end="", flush=True)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:
import os
from sudo import Sudo
from sudo.utils import BackoffStrategy, RetryConfig
with Sudo(
server_url="https://api.example.com",
api_key=os.getenv("SUDO_API_KEY", ""),
) as s_client:
res = s_client.system.health_check(,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
# Handle response
print(res)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:
import os
from sudo import Sudo
from sudo.utils import BackoffStrategy, RetryConfig
with Sudo(
server_url="https://api.example.com",
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
api_key=os.getenv("SUDO_API_KEY", ""),
) as s_client:
res = s_client.system.health_check()
# Handle response
print(res)SudoError 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 |
err.data |
Optional. Some errors may contain structured data. See Error Classes. |
import os
from sudo import Sudo, errors
with Sudo(
server_url="https://api.example.com",
api_key=os.getenv("SUDO_API_KEY", ""),
) as s_client:
res = None
try:
res = s_client.system.get_supported_models()
# Handle response
print(res)
except errors.SudoError 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)
# Depending on the method different errors may be thrown
if isinstance(e, errors.ErrorResponse):
print(e.data.error) # models.ErrorDetailPrimary errors:
SudoError: The base class for HTTP error responses.
Less common errors (5)
Network errors:
httpx.RequestError: Base class for request errors.httpx.ConnectError: HTTP client was unable to make a request to a server.httpx.TimeoutException: HTTP request timed out.
Inherit from SudoError:
ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via thecauseattribute.
* Check the method documentation to see if the error is applicable.
The Python SDK makes API calls using the httpx 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:
from sudo import Sudo
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Sudo(client=http_client)or you could wrap the client with your own custom logic:
from sudo import Sudo
from sudo.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 = Sudo(async_client=CustomClient(httpx.AsyncClient()))The Sudo 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 and reuse it across the application.
import os
from sudo import Sudo
def main():
with Sudo(
server_url="https://api.example.com",
api_key=os.getenv("SUDO_API_KEY", ""),
) as s_client:
# Rest of application here...
# Or when using async:
async def amain():
async with Sudo(
server_url="https://api.example.com",
api_key=os.getenv("SUDO_API_KEY", ""),
) as s_client:
# Rest of application here...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.
from sudo import Sudo
import logging
logging.basicConfig(level=logging.DEBUG)
s = Sudo(server_url="https://example.com", debug_logger=logging.getLogger("sudo"))You can also enable a default debug logger by setting an environment variable SUDO_DEBUG to true.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.