Metadata-Version: 2.5
Name: brellium-api-client
Version: 0.3.0
Summary: The Brellium API gives your systems access to your organization's documents, audits, coding evaluations, question sets, users and email recipients. It uses OAuth2 client credentials, cursor pagination and snake_case JSON.
Project-URL: Source, https://github.com/brellium-ai/api-client-python
Project-URL: Issues, https://github.com/brellium-ai/api-client-python/issues
Project-URL: Changelog, https://github.com/brellium-ai/api-client-python/blob/main/CHANGELOG.md
Author: Brellium API
License-Expression: Apache-2.0
License-File: LICENSE
Requires-Python: >=3.9
Requires-Dist: anyio<5,>=3.5.0
Requires-Dist: httpx<1,>=0.23.0
Requires-Dist: pydantic<3,>=1.9.0
Requires-Dist: sniffio
Requires-Dist: typing-extensions<5,>=4.14
Provides-Extra: aiohttp
Requires-Dist: aiohttp; extra == 'aiohttp'
Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
Description-Content-Type: text/markdown

# Brellium API

This library provides convenient access to the Brellium API from Python.

The full API of this library can be found in [api.md](./api.md).

<br />

## Contents

- [Installation](#installation)
- [Usage](#usage)
- [API Reference](./api.md)
- [Async](#async)
- [Authentication](#authentication)
- [Errors](#errors)
- [Client Options](#client-options)
- [Retries and Timeouts](#retries-and-timeouts)
- [Helpers](#helpers)
- [Logging](#logging)
- [Requirements](#requirements)

<br />

## Installation

```sh
pip install brellium-api-client
```

<br />

## Usage

```python
import os

from brellium_api_client import BrelliumClient

client = BrelliumClient(
    o_auth2=os.environ.get("BRELLIUM_ACCESS_TOKEN"),
)

documents = client.documents.list(
    limit=20,
)

print(documents)
```

The examples in the following sections assume a `client` configured as shown above.

See the [API reference](./api.md) for every available operation.

<br />

## Async

Every client has an `Async` counterpart (`AsyncBrelliumClient`) exposing the same resource tree with `await`.

```python
import asyncio

from brellium_api_client import AsyncBrelliumClient


async def main() -> None:
    client = AsyncBrelliumClient()
    documents = await client.documents.list(
        limit=20,
    )


asyncio.run(main())
```

<br />

## Authentication

Pass credentials to the generated client constructor. Environment variables are read automatically when supported by the target runtime.

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `o_auth2` | `str \| None` | - | Mint an access token at `POST /v2/oauth/token` with your client id and secret, and send it as `Authorization: Bearer <token>`. The token lasts the number of seconds in the response's `expires_in` (about a day). Cache it and reuse it until it is about to expire. A key is bound to your organization, so the token carries your `org_id`. For a sandbox key, mint tokens with the audience `https://api.brellium.dev/sandbox` instead of `https://api.brellium.dev`. Defaults to BRELLIUM_ACCESS_TOKEN. |

Declared schemes:

- `OAuth2` OAuth2/OpenID Connect

<br />

## Errors

Non-success responses throw generated API errors. Error objects expose status, headers, response body, and request metadata where the target runtime supports it.

```python
from brellium_api_client import APIStatusError

try:
    documents = client.documents.list(
        limit=20,
    )
except APIStatusError as err:
    print(err.status_code, err.message)
    raise
```

Documented error statuses: `400`, `401`, `404`, `409`, `429`, `502`.

<br />

## Client Options

Configure the generated client by setting any of these options when you create it.

```python
from brellium_api_client import BrelliumClient

client = BrelliumClient(
    timeout=60.0,
    max_retries=2,
)
```

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `o_auth2` | `str \| None` | `os.environ.get("BRELLIUM_ACCESS_TOKEN")` | Mint an access token at `POST /v2/oauth/token` with your client id and secret, and send it as `Authorization: Bearer <token>`. The token lasts the number of seconds in the response's `expires_in` (about a day). Cache it and reuse it until it is about to expire. A key is bound to your organization, so the token carries your `org_id`. For a sandbox key, mint tokens with the audience `https://api.brellium.dev/sandbox` instead of `https://api.brellium.dev`. |
| `base_url` | `str \| httpx.URL \| None` | - | Override the default API base URL. |
| `timeout` | `float \| Timeout \| None` | `60.0` | Maximum time in seconds to wait for a response before aborting a request. |
| `max_retries` | `int` | `2` | Number of retries for temporary failures. |
| `default_headers` | `Mapping[str, str] \| None` | - | Headers sent with every request. |
| `default_query` | `Mapping[str, object] \| None` | - | Query parameters sent with every request. |

<br />

## Retries and Timeouts

Generated clients support request timeouts and retry temporary failures such as network errors, 408, 409, 429, and 5xx responses. Retry delays honor `Retry-After` headers when present. Tune the retry and timeout client options shown above, or override them per request.

<br />

## Helpers

- Use `client.with_raw_response.<resource>.<method>(...)` to access the raw `httpx.Response` and parse it yourself.
- Use `client.with_streaming_response.<resource>.<method>(...)` to stream a response body without buffering it.

<br />

## Logging

- Set the `BRELLIUM_LOG` environment variable to `info` or `debug` to enable HTTP logging.
- Logs are emitted through the standard `logging` module under the `brellium_api_client` logger.
- Importing the SDK wraps the process's log record factory: records from the SDK, `httpx`, `httpcore`, `hpack` and `websockets` loggers have credential headers, credential query parameters and URL userinfo logged as `***`. A record factory installed later that does not chain to the previous one turns this off.

<br />

## Requirements

- Python 3.9 or newer

Powered by Scalar.
