Example API Python SDK

This SDK is generated from the spec-repo-downstream-sdks example.

Overview

This repository demonstrates a downstream SDK that is automatically generated when changes are made to a central spec repository. The workflow:

1. A PR is created in the spec repo with OpenAPI spec changes
2. The spec repo workflow triggers this repo's generate-sdk-from-spec.yaml workflow
3. This workflow generates the SDK and creates a PR for review

Installation

pip install example-api

Usage

from example_api import ExampleAPI

client = ExampleAPI()

# List users
users = client.users.list_users()

# Get a specific user
user = client.users.get_user(id="user-123")

Related

• Spec repo example
• TypeScript SDK

Summary

Example API: A simple example API to demonstrate spec repo SDK generation workflow

Table of Contents

• Example API Python SDK
  • Overview
  • Installation
  • Usage
  • Related
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging

SDK Installation

[!TIP]
To finish publishing your SDK to PyPI you must run your first generation action.

[!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 git+https://github.com/speakeasy-api/examples-downstream-spec-sdk-python.git

PIP

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

pip install git+https://github.com/speakeasy-api/examples-downstream-spec-sdk-python.git

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 git+https://github.com/speakeasy-api/examples-downstream-spec-sdk-python.git

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 example-api 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.9"
# dependencies = [
#     "example-api",
# ]
# ///

from example_api import ExampleAPI

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

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from example_api import ExampleAPI

with ExampleAPI() as ea_client:

    res = ea_client.list_users()

    # Handle response
    print(res)

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

# Asynchronous Example
import asyncio
from example_api import ExampleAPI

async def main():

    async with ExampleAPI() as ea_client:

        res = await ea_client.list_users_async()

        # Handle response
        print(res)

asyncio.run(main())

Available Resources and Operations

Available methods

ExampleAPI SDK

• list_users - List all users
• create_user - Create a user
• get_user - Get a user

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 example_api import ExampleAPI
from example_api.utils import BackoffStrategy, RetryConfig

with ExampleAPI() as ea_client:

    res = ea_client.list_users(,
        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 example_api import ExampleAPI
from example_api.utils import BackoffStrategy, RetryConfig

with ExampleAPI(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as ea_client:

    res = ea_client.list_users()

    # Handle response
    print(res)

Error Handling

ExampleAPIError is the base class for all HTTP error responses. It has the following properties:

Example

from example_api import ExampleAPI, errors

with ExampleAPI() as ea_client:
    res = None
    try:

        res = ea_client.list_users()

        # Handle response
        print(res)

    except errors.ExampleAPIError 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:

• ExampleAPIError: 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 ExampleAPIError:

• ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

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 example_api import ExampleAPI

with ExampleAPI(
    server_url="https://api.example.com",
) as ea_client:

    res = ea_client.list_users()

    # 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 example_api import ExampleAPI
import httpx

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

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

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

Resource Management

The ExampleAPI 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 example_api import ExampleAPI
def main():

    with ExampleAPI() as ea_client:
        # Rest of application here...

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

    async with ExampleAPI() as ea_client:
        # 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 example_api import ExampleAPI
import logging

logging.basicConfig(level=logging.DEBUG)
s = ExampleAPI(debug_logger=logging.getLogger("example_api"))