Skip to main content

Proofbeak

Check whether a service meets your requirements. Decide with evidence.

English · Türkçe

Proofbeak is a self-hosted acceptance-testing and evidence service for developers and AI agents. Define the behavior your application needs, choose candidate services, and run the same scenario against each one. Proofbeak reports what it observed so you can make an informed service-selection or integration decision.

You write your own scenarios in JSON by combining available connector operations, test data and acceptance conditions. The included examples are starting points you can adapt.

How it works

  1. Define the preparation, actions, observations and expected results.
  2. Choose compatible services from the configured candidates.
  3. Validate the definition before starting provider work.
  4. Run the trial and check its outcome through independent reads.
  5. Inspect the comparison, evidence and separate cleanup status.
Result Meaning
pass The observations satisfy the requested conditions.
fail An observed value violates a requested condition.
inconclusive Missing observations or an operational issue prevent a conclusion.

JSON and HTML reports include expected and observed values, before/after records and evidence provenance. The developer or external agent makes the final choice.

Quick start

From a checkout, use Python 3.11+ on Linux or macOS. This local example needs no additional Python packages, external account or model service:

PYTHONPATH=src python3 -m proofbeak example --output scenario.json
PYTHONPATH=src python3 -m proofbeak validate scenario.json \
  --candidate scenario:filesystem
PYTHONPATH=src python3 -m proofbeak run scenario.json \
  --candidate scenario:filesystem --key first-trial \
  --output reports/first-trial.json --html reports/first-trial.html

Open reports/first-trial.html to inspect the result. The example uses disposable files. Copy the JSON and edit it for your condition; use a new key for a changed definition. Repeating the same request and key retrieves the original run.

Follow the scenario guide to author a definition and apply it to multiple configured services.

Interfaces and scope

Use Proofbeak through CLI, REST or MCP. Provider connections and credentials are configured by the operator; the external agent runtime stays under your control.

User-defined scenarios currently support object write/read/list/delete operations and configured read-only HTTP JSON requests. Composing these operations requires only a JSON definition. Supporting a new protocol or operation requires a trusted connector.

Run directly in Python, in a container or on standard Kubernetes/Helm. The current deployment scope uses one coordinator with SQLite state. See the deployment guide for configuration and operating limits.

Documentation

Contributing · Architecture · Roadmap · Apache-2.0

Metadata

Release files for proofbeak 0.6.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 proofbeak 0.6.0
File Size Uploaded Provenance Actions
proofbeak-0.6.0.tar.gz 232.5 kB With provenance Details for proofbeak-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for proofbeak 0.6.0
File Interpreter ABI Platform Actions
proofbeak-0.6.0-py3-none-any.whl Python 3 none any Details for proofbeak-0.6.0-py3-none-any.whl

Total release size: 314.2 kB

Release files / proofbeak-0.6.0.tar.gz

Download URL proofbeak-0.6.0.tar.gz
Size 232.5 kB
Tags Source
SHA-256 checksum
How to use checksums
1d64733f808d67aa5c2651fd8b867fc6896586ec56efac433a394413792a7aae
BLAKE2b-256 checksum
How to use checksums
27fd36aee8201745de60436ca4065f9272f81c899897158adac1fbd46b4f8304
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 13, 2026.

Transparency log

Release files / proofbeak-0.6.0-py3-none-any.whl

Download URL proofbeak-0.6.0-py3-none-any.whl
Size 81.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
490e6dbdedfd4dd6594b4a14496dd21b09d54cb8201927f06c706b5e37cdd6d2
BLAKE2b-256 checksum
How to use checksums
59f71e8f81e2968cd6d178f315e910d27296651facc679d10ddf8fbe8e048fb7
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 13, 2026.

Transparency log

Security for proofbeak 0.6.0

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 proofbeak-0.6.0.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 13, 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