🌿 Fern Regeneration -- April 1, 2026

.fern/metadata.json

@@ -1,10 +1,10 @@
 {
   "cliVersion": "4.53.1",
   "generatorName": "fernapi/fern-python-sdk",
-  "generatorVersion": "4.61.0",
+  "generatorVersion": "4.64.1",
   "generatorConfig": {
     "client_class_name": "RespanClient"
   },
-  "originGitCommit": "6fa5472be849e7dcfbcbdc84a3dec04204755705",
-  "sdkVersion": "0.0.0-20260401-6fa5472"
+  "originGitCommit": "99ac007ff3f9ad6ffe0bdbddceb55d90301c1d12",
+  "sdkVersion": "0.0.0-20260401-99ac007"
 }

.github/workflows/ci.yml

@@ -1,5 +1,10 @@
 name: ci
 on: [push]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
 jobs:
   compile:
     runs-on: ubuntu-latest
@@ -9,7 +14,7 @@ jobs:
       - name: Set up python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: "3.9"
       - name: Bootstrap poetry
         run: |
           curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
@@ -25,7 +30,7 @@ jobs:
       - name: Set up python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: "3.9"
       - name: Bootstrap poetry
         run: |
           curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1

README.md

@@ -0,0 +1,191 @@
+# Respan Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Frespanai%2Frespan-python-api)
+[![pypi](https://img.shields.io/pypi/v/respan)](https://pypi.python.org/pypi/respan)
+
+The Respan Python library provides convenient access to the Respan APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Pagination](#pagination)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install respan
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/respanai/respan-python-api/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from respan import RespanClient
+
+client = RespanClient()
+
+client.spans.create_span(
+    authorization="Bearer sk_live_xxxxx",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from respan import AsyncRespanClient
+
+client = AsyncRespanClient()
+
+
+async def main() -> None:
+    await client.spans.create_span(
+        authorization="Bearer sk_live_xxxxx",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from respan.core.api_error import ApiError
+
+try:
+    client.spans.create_span(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Pagination
+
+Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
+
+```python
+from respan import RespanClient
+import datetime
+
+client = RespanClient()
+
+client.spans.list_spans(
+    sort_by="-cost",
+    start_time=datetime.datetime.fromisoformat("2025-01-01T00:00:00+00:00"),
+    end_time=datetime.datetime.fromisoformat("2025-01-31T23:59:59+00:00"),
+    environment="production",
+    include_fields="customer_identifier,model,cost,latency",
+    authorization="Bearer sk_live_xxxxx",
+    operator="AND",
+)
+```
+
+```python
+# You can also iterate through pages and access the typed response per page
+pager = client.spans.list_spans(...)
+for page in pager.iter_pages():
+    print(page.response)  # access the typed response for each page
+    for item in page:
+        print(item)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from respan import RespanClient
+
+client = RespanClient(...)
+response = client.spans.with_raw_response.create_span(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.spans.create_span(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+from respan import RespanClient
+
+client = RespanClient(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.spans.create_span(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from respan import RespanClient
+
+client = RespanClient(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!