Skip to main content

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. The current generated package version is 0.1.0.

The current generation command is:

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=1.0.3,hideGenerationTimestamp=true,library=httpx

Regenerating

When the AuditHub API schema changes, regenerate the SDK from the repository root and pass the new SDK version:

scripts/regenerate-sdk.sh 0.1.1

The script passes that version as packageVersion to OpenAPI Generator, then syncs repository-maintained version references in:

  • pyproject.toml
  • setup.py
  • README.md
  • AGENTS.md

The version in this README's generator command is intentionally updated only when regenerating the SDK.

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

  • README.md
  • packaging metadata
  • CI workflows
  • scripts/regenerate-sdk.sh

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

Version Bumping

bump-my-version is configured in pyproject.toml for release-only version bumps. For API schema changes, use scripts/regenerate-sdk.sh VERSION instead. The bump command updates package metadata and runtime package-version strings, commits the change, and creates a vX.Y.Z tag:

uv tool install bump-my-version
bump-my-version bump patch

To set an exact version:

bump-my-version bump --new-version 0.1.1

The bump configuration intentionally does not update this README's generator command. That command is updated by scripts/regenerate-sdk.sh when the SDK is regenerated.

Installation

From PyPI:

pip install audithub-sdk

From the repository:

pip install .

Usage

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:

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:

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:

python -m build

Publishing is handled by .github/workflows/publish.yml from a GitHub release tag. The workflow does not edit version files; it fails unless the tag version matches:

  • pyproject.toml
  • setup.py
  • audithub_sdk/__init__.py

Use vX.Y.Z tags for releases, for example:

git tag v0.1.1
git push origin v0.1.1

Metadata

Release files for audithub-sdk 1.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for audithub-sdk 1.0.3
File Size Uploaded Provenance Actions
audithub_sdk-1.0.3.tar.gz 194.4 kB With provenance Details for audithub_sdk-1.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for audithub-sdk 1.0.3
File Interpreter ABI Platform Actions
audithub_sdk-1.0.3-py3-none-any.whl Python 3 none any Details for audithub_sdk-1.0.3-py3-none-any.whl

Total release size: 621.1 kB

Release files / audithub_sdk-1.0.3.tar.gz

Download URL audithub_sdk-1.0.3.tar.gz
Size 194.4 kB
Tags Source
SHA-256 checksum
How to use checksums
eb139c2c4df9b4034507d345e63feda440b6e8725b0ea05cdade73c29c9174af
BLAKE2b-256 checksum
How to use checksums
817e6064aa4c5040aa010a84ceece455f4738cb423611eaf38ce766f6fed81e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / audithub_sdk-1.0.3-py3-none-any.whl

Download URL audithub_sdk-1.0.3-py3-none-any.whl
Size 426.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
26d0dc040438d9717bb00d8eed141b05d81c01f73be76b07065ce2553528409e
BLAKE2b-256 checksum
How to use checksums
9449dd4f371a62bc4b062437dce32eae2e80ab03d6a1f7396225c901c67b1979
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Security for audithub-sdk 1.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for audithub_sdk-1.0.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page