oneharness-sdk

Async Python access to the oneharness engine, generated from and validated against the Rust-owned JSON Schema contracts. The distribution is oneharness-sdk, the import is oneharness_sdk, and every release depends on the exact same oneharness-cli version.

pip install oneharness-sdk

import asyncio

from oneharness_sdk import OneHarness


async def main() -> None:
    oneharness = OneHarness()
    report = await oneharness.run(
        {"prompt": "Summarize this repository", "harnesses": ["codex"]}
    )
    print(report["results"][0]["text"])


asyncio.run(main())

Every JSON-returning method passes --format json --compact itself, so the CLI's own default (a human-readable text view) never reaches the SDK. A run over several harnesses is a fallback chain by default — the first candidate that can run does, and the report's fallback block says which; pass "run_mode": "parallel" to run them all at once.

The client covers every verb the CLI exposes, so nothing needs a hand-built command line: run, run_mock, run_stream, list, detect, config, sync, init, usage, gate, mock, interrupt, history, history_list, history_watch, history_clear, history_migrate, and history_pointers. That coverage is gated, not asserted here. run_mock uses the deterministic responder shipped in the CLI; see Testing patterns. run_stream and history_watch are async iterators. Every envelope is validated before it is yielded; closing or cancelling an iterator terminates its subprocess.

An option whose name is a Python keyword takes the conventional trailing underscore — sync({"global_": True}) sends --global — and nothing else about the spelling changes.

async for envelope in oneharness.run_stream(
    {"prompt": "Inspect this repository", "harnesses": ["codex"]}
):
    if envelope["type"] == "event" and envelope["event"]["name"] == "shell":
        break

async for envelope in oneharness.history_watch(
    {"labels": {"graph": "release"}, "after": last_history_id}
):
    print(envelope["record"]["history_id"])

Python input keys are snake case and strict: unknown fields and misspellings fail before the CLI starts. Output dictionaries preserve additive fields from newer compatible CLI versions. history and history_watch raise HistoryNotFoundError when a session, record, or cursor cannot be resolved.

Metadata

Release files for oneharness-sdk 0.17.0

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

Source distribution (sdist)

Source distribution for oneharness-sdk 0.17.0
File	Size	Uploaded
oneharness_sdk-0.17.0.tar.gz	106.0 kB	Sep 29, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for oneharness-sdk 0.17.0
File	Interpreter	ABI	Platform	Reset
oneharness_sdk-0.17.0-py3-none-any.whl 108.5 kB Sep 29, 2026	Python 3	none	any	Details

Total release size: 214.5 kB

Release files / oneharness_sdk-0.17.0.tar.gz

Download URL	oneharness_sdk-0.17.0.tar.gz
Size	106.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`7520a0fc9f5d5636c5ab19867f521e4dc77fa2ab8971ce6a93280bbe0d89018b`
BLAKE2b-256 checksum How to use checksums	`449dc6f7f7d8471d7e2d5b9e0dd0f4365897d733778c9554fe8f8f5eb6d999b1`
Upload date	Sep 29, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

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.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/nickderobertis/oneharness
Publishing commit: github.com/nickderobertis/oneharness/tree/c42752b97439a720ff5dcd5703edd754692d8657

Workflow

Publishing configuration: github.com/nickderobertis/oneharness/blob/c42752b97439a720ff5dcd5703edd754692d8657/.github/workflows/release.yml
Publishing logs: github.com/nickderobertis/oneharness/actions/runs/36529589530/attempts/1

Artifact

Subject: oneharness_sdk-0.17.0.tar.gz
SHA-256 checksum: 7520a0fc9f5d5636c5ab19867f521e4dc77fa2ab8971ce6a93280bbe0d89018b Verifying attestations

Release files / oneharness_sdk-0.17.0-py3-none-any.whl

Download URL	oneharness_sdk-0.17.0-py3-none-any.whl
Size	108.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`dac4e96ca5bb3100fb75ec67b672747da2b5f7b8d45d69c5b58ab735270b94b3`
BLAKE2b-256 checksum How to use checksums	`2ea61a01b88ef454a6058305db14802367372dc64df9a2c9e1b27aa865faa077`
Upload date	Sep 29, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/nickderobertis/oneharness
Publishing commit: github.com/nickderobertis/oneharness/tree/c42752b97439a720ff5dcd5703edd754692d8657

Workflow

Publishing configuration: github.com/nickderobertis/oneharness/blob/c42752b97439a720ff5dcd5703edd754692d8657/.github/workflows/release.yml
Publishing logs: github.com/nickderobertis/oneharness/actions/runs/36529589530/attempts/1

Artifact

Subject: oneharness_sdk-0.17.0-py3-none-any.whl
SHA-256 checksum: dac4e96ca5bb3100fb75ec67b672747da2b5f7b8d45d69c5b58ab735270b94b3 Verifying attestations