{"id":48789538,"url":"https://github.com/speakeasy-api/examples-downstream-spec-sdk-python","last_synced_at":"2026-04-13T19:30:38.788Z","repository":{"id":334034287,"uuid":"1139764649","full_name":"speakeasy-api/examples-downstream-spec-sdk-python","owner":"speakeasy-api","description":"Example Python SDK generated from spec repo workflow","archived":false,"fork":false,"pushed_at":"2026-01-22T12:05:29.000Z","size":148,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-23T02:35:13.402Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/speakeasy-api.png","metadata":{"files":{"readme":"README-PYPI.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-22T11:39:03.000Z","updated_at":"2026-01-22T12:05:33.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/speakeasy-api/examples-downstream-spec-sdk-python","commit_stats":null,"previous_names":["speakeasy-api/examples-downstream-spec-sdk-python"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/speakeasy-api/examples-downstream-spec-sdk-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fexamples-downstream-spec-sdk-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fexamples-downstream-spec-sdk-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fexamples-downstream-spec-sdk-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fexamples-downstream-spec-sdk-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/speakeasy-api","download_url":"https://codeload.github.com/speakeasy-api/examples-downstream-spec-sdk-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fexamples-downstream-spec-sdk-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31768603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T15:25:13.801Z","status":"ssl_error","status_checked_at":"2026-04-13T15:25:09.162Z","response_time":93,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-13T19:30:38.044Z","updated_at":"2026-04-13T19:30:38.780Z","avatar_url":"https://github.com/speakeasy-api.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Example API Python SDK\n\nThis SDK is generated from the [spec-repo-downstream-sdks](https://github.com/speakeasy-api/examples/tree/main/spec-repo-downstream-sdks) example.\n\n## Overview\n\nThis repository demonstrates a downstream SDK that is automatically generated when changes are made to a central spec repository. The workflow:\n\n1. A PR is created in the spec repo with OpenAPI spec changes\n2. The spec repo workflow triggers this repo's `generate-sdk-from-spec.yaml` workflow\n3. This workflow generates the SDK and creates a PR for review\n\n## Installation\n\n```bash\npip install example-api\n```\n\n## Usage\n\n```python\nfrom example_api import ExampleAPI\n\nclient = ExampleAPI()\n\n# List users\nusers = client.users.list_users()\n\n# Get a specific user\nuser = client.users.get_user(id=\"user-123\")\n```\n\n## Related\n\n- [Spec repo example](https://github.com/speakeasy-api/examples/tree/main/spec-repo-downstream-sdks)\n- [TypeScript SDK](https://github.com/speakeasy-api/examples-downstream-spec-sdk-typescript)\n\n\u003c!-- Start Summary [summary] --\u003e\n## Summary\n\nExample API: A simple example API to demonstrate spec repo SDK generation workflow\n\u003c!-- End Summary [summary] --\u003e\n\n\u003c!-- Start Table of Contents [toc] --\u003e\n## Table of Contents\n\u003c!-- $toc-max-depth=2 --\u003e\n* [Example API Python SDK](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#example-api-python-sdk)\n  * [Overview](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#overview)\n  * [Installation](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#installation)\n  * [Usage](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#usage)\n  * [Related](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#related)\n  * [SDK Installation](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#sdk-installation)\n  * [IDE Support](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#ide-support)\n  * [SDK Example Usage](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#sdk-example-usage)\n  * [Available Resources and Operations](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#available-resources-and-operations)\n  * [Retries](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#retries)\n  * [Error Handling](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#error-handling)\n  * [Server Selection](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#server-selection)\n  * [Custom HTTP Client](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#custom-http-client)\n  * [Resource Management](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#resource-management)\n  * [Debugging](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/#debugging)\n\n\u003c!-- End Table of Contents [toc] --\u003e\n\n\u003c!-- Start SDK Installation [installation] --\u003e\n## SDK Installation\n\n\u003e [!TIP]\n\u003e To finish publishing your SDK to PyPI you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).\n\n\n\u003e [!NOTE]\n\u003e **Python version upgrade policy**\n\u003e\n\u003e 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 *uv*, *pip*, or *poetry* package managers.\n\n### uv\n\n*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.\n\n```bash\nuv add git+https://github.com/speakeasy-api/examples-downstream-spec-sdk-python.git\n```\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 git+https://github.com/speakeasy-api/examples-downstream-spec-sdk-python.git\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 git+https://github.com/speakeasy-api/examples-downstream-spec-sdk-python.git\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 example-api 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 = \"\u003e=3.9\"\n# dependencies = [\n#     \"example-api\",\n# ]\n# ///\n\nfrom example_api import ExampleAPI\n\nsdk = ExampleAPI(\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\u003c!-- End SDK Installation [installation] --\u003e\n\n\u003c!-- Start IDE Support [idesupport] --\u003e\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\u003c!-- End IDE Support [idesupport] --\u003e\n\n\u003c!-- Start SDK Example Usage [usage] --\u003e\n## SDK Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom example_api import ExampleAPI\n\n\nwith ExampleAPI() as ea_client:\n\n    res = ea_client.list_users()\n\n    # Handle response\n    print(res)\n```\n\n\u003c/br\u003e\n\nThe same SDK client can also be used to make asynchronous requests by importing asyncio.\n\n```python\n# Asynchronous Example\nimport asyncio\nfrom example_api import ExampleAPI\n\nasync def main():\n\n    async with ExampleAPI() as ea_client:\n\n        res = await ea_client.list_users_async()\n\n        # Handle response\n        print(res)\n\nasyncio.run(main())\n```\n\u003c!-- End SDK Example Usage [usage] --\u003e\n\n\u003c!-- Start Available Resources and Operations [operations] --\u003e\n## Available Resources and Operations\n\n\u003cdetails open\u003e\n\u003csummary\u003eAvailable methods\u003c/summary\u003e\n\n### [ExampleAPI SDK](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/docs/sdks/exampleapi/README.md)\n\n* [list_users](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/docs/sdks/exampleapi/README.md#list_users) - List all users\n* [create_user](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/docs/sdks/exampleapi/README.md#create_user) - Create a user\n* [get_user](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/docs/sdks/exampleapi/README.md#get_user) - Get a user\n\n\u003c/details\u003e\n\u003c!-- End Available Resources and Operations [operations] --\u003e\n\n\u003c!-- Start Retries [retries] --\u003e\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 example_api import ExampleAPI\nfrom example_api.utils import BackoffStrategy, RetryConfig\n\n\nwith ExampleAPI() as ea_client:\n\n    res = ea_client.list_users(,\n        RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\n    # Handle response\n    print(res)\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 example_api import ExampleAPI\nfrom example_api.utils import BackoffStrategy, RetryConfig\n\n\nwith ExampleAPI(\n    retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n) as ea_client:\n\n    res = ea_client.list_users()\n\n    # Handle response\n    print(res)\n\n```\n\u003c!-- End Retries [retries] --\u003e\n\n\u003c!-- Start Error Handling [errors] --\u003e\n## Error Handling\n\n[`ExampleAPIError`](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/./src/example_api/errors/exampleapierror.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 example_api import ExampleAPI, errors\n\n\nwith ExampleAPI() as ea_client:\n    res = None\n    try:\n\n        res = ea_client.list_users()\n\n        # Handle response\n        print(res)\n\n\n    except errors.ExampleAPIError 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* [`ExampleAPIError`](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/./src/example_api/errors/exampleapierror.py): The base class for HTTP error responses.\n\n\u003cdetails\u003e\u003csummary\u003eLess common errors (5)\u003c/summary\u003e\n\n\u003cbr /\u003e\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 [`ExampleAPIError`](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/./src/example_api/errors/exampleapierror.py)**:\n* [`ResponseValidationError`](https://github.com/speakeasy-api/examples-downstream-spec-sdk-python/blob/master/./src/example_api/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\u003c/details\u003e\n\u003c!-- End Error Handling [errors] --\u003e\n\n\u003c!-- Start Server Selection [server] --\u003e\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 example_api import ExampleAPI\n\n\nwith ExampleAPI(\n    server_url=\"https://api.example.com\",\n) as ea_client:\n\n    res = ea_client.list_users()\n\n    # Handle response\n    print(res)\n\n```\n\u003c!-- End Server Selection [server] --\u003e\n\n\u003c!-- Start Custom HTTP Client [http-client] --\u003e\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 example_api import ExampleAPI\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = ExampleAPI(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom example_api import ExampleAPI\nfrom example_api.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    ) -\u003e 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    ) -\u003e 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 = ExampleAPI(async_client=CustomClient(httpx.AsyncClient()))\n```\n\u003c!-- End Custom HTTP Client [http-client] --\u003e\n\n\u003c!-- Start Resource Management [resource-management] --\u003e\n## Resource Management\n\nThe `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][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 example_api import ExampleAPI\ndef main():\n\n    with ExampleAPI() as ea_client:\n        # Rest of application here...\n\n\n# Or when using async:\nasync def amain():\n\n    async with ExampleAPI() as ea_client:\n        # Rest of application here...\n```\n\u003c!-- End Resource Management [resource-management] --\u003e\n\n\u003c!-- Start Debugging [debug] --\u003e\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 example_api import ExampleAPI\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = ExampleAPI(debug_logger=logging.getLogger(\"example_api\"))\n```\n\u003c!-- End Debugging [debug] --\u003e\n\n\u003c!-- Placeholder for Future Speakeasy SDK Sections --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-api%2Fexamples-downstream-spec-sdk-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeakeasy-api%2Fexamples-downstream-spec-sdk-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-api%2Fexamples-downstream-spec-sdk-python/lists"}