provenarium-client 0.1.0

Thin Python client for the Provenarium extraction API.

Provenarium Python Client

provenarium_client is a thin Python wrapper around the public Provenarium API.

It is intentionally focused on the main data-team workflow:

• list, create, and rotate machine API keys
• create or reuse schemas
• submit extraction jobs
• poll for results
• request hosted review for completed work
• manage webhook destinations

Full guide: docs.provenarium.com/python-client

Install

If the client is being distributed through PyPI for your environment:

pip install provenarium-client

Otherwise install it from the wheel, source checkout, or private package path provided for your environment.

The client defaults to https://api.provenarium.com. Only override base_url when pointing at a local or non-default hosted environment.

Quickstart

from provenarium_client import SchemaField, ProvenariumClient

with ProvenariumClient(
    api_key="pk_live_...",
) as client:
    schema = client.create_schema(
        name="Assay Packet",
        description="Fields to pull from assay packets.",
        fields=[
            SchemaField(
                name="study_id",
                display_name="Study ID",
                description="Internal study identifier.",
                group="study_info",
                path="study_info.study_id",
                field_type="String",
            ),
            SchemaField(
                name="run_id",
                display_name="Run ID",
                description="Instrument run identifier.",
                group="assay_run",
                path="assay_run.run_id",
                field_type="String",
            ),
        ],
    )

    job = client.submit_job(
        file_path="packet.pdf",
        schema_id=schema.id,
    )

    result = client.wait_for_result(
        job.id,
        poll_interval_seconds=2.0,
        timeout_seconds=120.0,
    )

    print(result.summary.field_count)
    print(result.fields[0].value)

Hosted Review

Route a completed job into hosted review later:

from provenarium_client import ProvenariumClient

with ProvenariumClient(api_key="pk_live_...") as client:
    reviewed_job = client.request_review(
        "job_123",
        reviewer_email="[e-mail]",
        reviewer_team="qa-team",
    )
    print(reviewed_job.review.status)
    print(reviewed_job.reviewer_notification)

If review should be part of the job from the start, pass requires_review=True and reviewer details directly to submit_job(...).

API Keys

The client can also wrap the public API-key routes for scripted key rotation:

from provenarium_client import ProvenariumClient

with ProvenariumClient(api_key="pk_admin_...") as client:
    created = client.create_api_key(
        name="ingestion-bot",
        role="member",
    )
    print(created.token)

    for key in client.list_api_keys():
        print(key.name, key.role, key.is_active)

    client.delete_api_key(created.id)

Notes

• this client wraps the public /api/v1/* surface only
• API key management calls require an owner or admin team API key
• use the docs app and API reference for the canonical integration guide and exact wire payloads
• it does not cover dashboard auth, internal provisioning, or reviewer submission
• the package is intentionally a lightweight convenience layer, not a heavy SDK

Tests

uv run pytest -q

Publishing

The client is published through GitHub Actions, separately from the hosted app deploy.

Release flow:

git tag client-v0.1.0
git push origin client-v0.1.0

Notes:

• the tag must match the version in pyproject.toml
• the workflow builds the wheel and source distribution, runs twine check, and then publishes to PyPI
• publishing uses PyPI Trusted Publishing through GitHub Actions OIDC, not a long-lived API token
• the GitHub repository should have a pypi environment, and PyPI should trust this repo/workflow pair

PyPI Trusted Publisher fields:

• PyPI project name: provenarium-client
• Owner: andrewruba
• Repository name: provenarium
• Workflow name: publish-client.yml
• Environment name: pypi