Python Client SDK Generated by Speakeasy.

Navigation

Verified details

These details have been verified by PyPI
Owner
Maintainers
Avatar for mesa-ci-bot from gravatar.com mesa-ci-bot

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache-2.0
  • Author: Speakeasy
  • Requires: Python >=3.10
Report project as malware

Project description

Mesa Python SDK

This package is generated from the Depot OpenAPI specification with Speakeasy.

Do not manually edit generated files in this package. Update the OpenAPI spec and regenerate instead.

Summary

Depot API: Depot HTTP API v1

Table of Contents

SDK Installation

[!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 uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add mesa-sdk

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install mesa-sdk

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.

poetry add mesa-sdk

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from mesa-sdk python

It'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.10"
# dependencies = [
#     "mesa-sdk",
# ]
# ///

from mesa_sdk import Mesa

sdk = Mesa(
  # 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.

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.

SDK Example Usage

Example

# Synchronous Example
from mesa_sdk import Mesa


with Mesa(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as mesa:

    res = mesa.admin.create_api_key(org="<value>")

    # Handle response
    print(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from mesa_sdk import Mesa

async def main():

    async with Mesa(
        api_key="<YOUR_BEARER_TOKEN_HERE>",
    ) as mesa:

        res = await mesa.admin.create_api_key_async(org="<value>")

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
api_key http HTTP Bearer

To authenticate with the API the api_key parameter must be set when initializing the SDK client instance. For example:

from mesa_sdk import Mesa


with Mesa(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as mesa:

    res = mesa.admin.create_api_key(org="<value>")

    # Handle response
    print(res)

Available Resources and Operations

Available methods

Admin

AgentBlame

Branches

Commits

Content

  • get - Get content

Diffs

  • get - Get diff

Lfs

Merge

Org

  • get - Get organization

Repos

Webhooks

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is None, then there are no more pages to be fetched.

Here's an example of one such pagination call:

from mesa_sdk import Mesa


with Mesa(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as mesa:

    res = mesa.repos.list(org="<value>")

    while res is not None:
        # Handle items

        res = res.next()

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:

from mesa_sdk import Mesa
from mesa_sdk.utils import BackoffStrategy, RetryConfig


with Mesa(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as mesa:

    res = mesa.admin.create_api_key(org="<value>",
        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:

from mesa_sdk import Mesa
from mesa_sdk.utils import BackoffStrategy, RetryConfig


with Mesa(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as mesa:

    res = mesa.admin.create_api_key(org="<value>")

    # Handle response
    print(res)

Error Handling

MesaError 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.

Example

from mesa_sdk import Mesa, errors


with Mesa(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as mesa:
    res = None
    try:

        res = mesa.admin.create_api_key(org="<value>")

        # Handle response
        print(res)


    except errors.MesaError 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.PostByOrgAPIKeysBadRequestError):
            print(e.data.error)  # models.PostByOrgAPIKeysBadRequestError

Error Classes

Primary error:

  • MesaError: The base class for HTTP error responses.
Less common errors (201)

Network errors:

Inherit from MesaError:

* Check the method documentation to see if the error is applicable.

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:

from mesa_sdk import Mesa


with Mesa(
    server_url="https://depot.mesa.dev/api/v1",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as mesa:

    res = mesa.admin.create_api_key(org="<value>")

    # Handle response
    print(res)

Custom HTTP Client

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 mesa_sdk import Mesa
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Mesa(client=http_client)

or you could wrap the client with your own custom logic:

from mesa_sdk import Mesa
from mesa_sdk.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 = Mesa(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The Mesa 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.

from mesa_sdk import Mesa
def main():

    with Mesa(
        api_key="<YOUR_BEARER_TOKEN_HERE>",
    ) as mesa:
        # Rest of application here...


# Or when using async:
async def amain():

    async with Mesa(
        api_key="<YOUR_BEARER_TOKEN_HERE>",
    ) as mesa:
        # Rest of application here...

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.

from mesa_sdk import Mesa
import logging

logging.basicConfig(level=logging.DEBUG)
s = Mesa(debug_logger=logging.getLogger("mesa_sdk"))

Project details

Verified details

These details have been verified by PyPI
Owner
Maintainers
Avatar for mesa-ci-bot from gravatar.com mesa-ci-bot

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache-2.0
  • Author: Speakeasy
  • Requires: Python >=3.10

Release history Release notifications | RSS feed

0.22.0

0.21.0

0.20.0

0.19.0

0.18.0

0.3.2

0.3.1

This version

0.3.0

0.1.2

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mesa_sdk-0.3.0.tar.gz (106.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mesa_sdk-0.3.0-py3-none-any.whl (145.9 kB view details)

Uploaded Python 3

File details

Details for the file mesa_sdk-0.3.0.tar.gz.

File metadata

  • Download URL: mesa_sdk-0.3.0.tar.gz
  • Upload date:
  • Size: 106.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mesa_sdk-0.3.0.tar.gz
Algorithm Hash digest
SHA256 c0a31e69299eac8aa96b1ed5b0f6e5c3831bc355168f5dfa1753b3dff62328a3
MD5 a3a10ecfe58c8f5151054126b16a5b2f
BLAKE2b-256 bcca37d1ed73d24ca12063493b38d93360b651d59f6720f29c9bf51563da9997

See more details on using hashes here.

File details

Details for the file mesa_sdk-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: mesa_sdk-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 145.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mesa_sdk-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 12956b8681275939d2869f86106325ffd35255b6c6e5a37530e88dfb18cb0c02
MD5 f52f086b7e2061087139b9b5a5b36ad7
BLAKE2b-256 5ac52f3898f38108109c990577929dc5f6c6c576ba574a949488f2065b5e88c7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page