Offline authoring and conformance tools for BenchWeave OTDP device plugins.

AI / Agents

Skills
llms.txt
llms-full.txt

Community

Contributing guide
Code of conduct
Security policy
Full license MIT

Meta

Requires: Python >=3.13
Provides-Extra: test, signing, server, scaffold
Package Info

New to the plugin SDK? Start with the Get started page. It walks the path from an empty directory to a first check-pass, with the command and the expected output at every step.

The BenchWeave plugin developer SDK is the offline toolkit to develop BenchWeave OTDP device plugins. Use it to generate a plugin project. Use it to implement and test the plugin against SDK-supplied interfaces and scripted mocks. Use it to validate descriptor and presentation contracts offline. Use it to prepare a reviewed release. You do not import gateway internals in any of these steps.

The SDK is a separate wheel from the BenchWeave gateway. PyPI publishes it as benchweave-sdk. The main BenchWeave repository mounts it at packages/sdk as a git submodule. The SDK has its own CI and release cycle. Python 3.13+, OTDP 0.2.2 and adapter API 1.1 are the baseline. pyproject.toml and the changelog give the SDK’s own version. This page does not claim a version.

Installation

Stable releases are on PyPI:

pip install benchweave-sdk
# or as an isolated CLI tool
uv tool install benchweave-sdk
# or via Homebrew (macOS and Linux)
brew install madeinoz67/tap/benchweave-sdk

For the newest unreleased code, install from the default branch:

pip install git+https://github.com/madeinoz67/benchweave-sdk.git

To do development work on the SDK itself, clone the repository. Then run uv sync --extra test.

Quick start

Generate an independent plugin project with one command:

benchweave-sdk new plugins/acme/model100 --package benchweave_acme_model100

The generator creates a standalone project. The project has a source package, an explicitly synthetic protocol, generated mock and conformance tests, and an AI-GUIDE.md. The AI-GUIDE.md describes the design, build, test, review and release workflow. The path from there has five steps: install, generate, replace the synthetic protocol with verified device behaviour, run the checks, then prepare and approve a release. The plugin developer guide walks through each step. The Get started page walks the full sequence with the exact commands and the expected output.

Documentation

The BenchWeave gateway, the canonical architecture and contract standards, the compatibility matrix and the device-level integration guides live in the main BenchWeave repository.