Metadata-Version: 2.4
Name: audithub-sdk
Version: 0.1.0
Summary: Generated Python SDK for the AuditHub API.
Home-page: https://github.com/Veridise/audithub-sdk
Author: Veridise
Project-URL: Homepage, https://audithub.dev.veridise.tools/
Project-URL: Documentation, https://audithub.dev.veridise.tools/api/v1/openapi.json
Project-URL: Repository, https://github.com/Veridise/audithub-sdk
Keywords: AuditHub,OpenAPI,SDK,API client
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >= 3.9
Description-Content-Type: text/markdown
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: httpx>=0.28.1
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: home-page
Dynamic: requires-python

# audithub-sdk

`audithub-sdk` is the generated Python SDK for the AuditHub API at `https://audithub.dev.veridise.tools/api/v1`.
This repository is intended to be the core dependency used by other Python repos that need a typed client for interacting with AuditHub.

## Generation

The client code in this repository is generated from the live OpenAPI document:

`https://audithub.dev.veridise.tools/api/v1/openapi.json`

The repository contents are produced with OpenAPI Generator 7.20.0 using:

```sh
openapi-generator generate \
  -i https://audithub.dev.veridise.tools/api/v1/openapi.json \
  -g python \
  -o . \
  --additional-properties=packageName=audithub_sdk,projectName=audithub-sdk,packageVersion=0.1.0,hideGenerationTimestamp=true,library=httpx
```

## Regenerating

When the AuditHub API schema changes, regenerate the SDK from the repository root with the command above.

Manual changes in this repo should stay limited to repository-specific files such as:

- `README.md`
- packaging metadata
- CI workflows

Generated source, models, docs, and tests should be replaced by regeneration rather than edited by hand.

## Installation

From PyPI:

```sh
pip install audithub-sdk
```

From the repository:

```sh
pip install .
```

## Usage

```python
import audithub_sdk

configuration = audithub_sdk.Configuration(
    host="https://audithub.dev.veridise.tools/api/v1"
)

async with audithub_sdk.ApiClient(configuration) as api_client:
    api = audithub_sdk.AdminApi(api_client)
    print(await api.about_admin_about_get())
```

For OIDC client-credentials authentication, use the handwritten extension package:

```python
import audithub_sdk
from audithub_sdk_ext import AuthenticatedApiClient, OIDCClientCredentialsContext

configuration = audithub_sdk.Configuration(
    host="https://audithub.dev.veridise.tools/api/v1"
)
auth_context = OIDCClientCredentialsContext(
    oidc_configuration_url="https://issuer.example/.well-known/openid-configuration",
    client_id="your-client-id",
    client_secret="your-client-secret",
)

async with AuthenticatedApiClient(configuration, auth_context=auth_context) as api_client:
    api = audithub_sdk.AdminApi(api_client)
    print(await api.about_admin_about_get())
```

## Testing

Install dependencies and run the generated test suite:

```sh
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r test-requirements.txt
pytest --cov=audithub_sdk
```

## Publishing

The repository includes `pyproject.toml` and `setup.py` so the package can be built and published to PyPI with standard Python packaging tools.

To build distributions locally:

```sh
python -m build
```
