benchbro 0.0.1

Benchmark library and CLI

benchbro

benchbro is a Python benchmarking library and CLI with pytest-style discovery and rich terminal output.

Quick start

Install dependencies:

uv sync --group dev

Create benchmark cases in any importable module:

from benchbro import Case

case = Case(name="hashing", case_type="cpu", metric_type="time", tags=["fast", "core"])


@case.input()
def payload() -> bytes:
    return b"benchbro"


@case.benchmark()
def sha1(payload: bytes) -> str:
    import hashlib

    return hashlib.sha1(payload).hexdigest()


@case.benchmark()
def sha256(payload: bytes) -> str:
    import hashlib

    return hashlib.sha256(payload).hexdigest()

GC is disabled during measured iterations by default. To keep the interpreter GC behavior unchanged, set:

Case(name="hashing", gc_control="inherit")

Run benchmarks:

uv run benchbro run --repeats 10 --warmup 2

When no target is provided, benchbro discovers benchmarks from:

• benchmarks/**/*.py (relative to repo root)

By default, run artifacts are written to .benchbro/:

• .benchbro/current.json
• .benchbro/current.csv

If requested, markdown output can also be written with --output-md.

JSON artifacts include environment metadata for reproducibility (Python/runtime/platform/CPU fields).

CLI basics

Run selected cases/tags and write outputs:

uv run benchbro run my_benchmarks.py \
  --case hashing \
  --tag fast \
  --output-json artifacts/current.json \
  --output-csv artifacts/current.csv \
  --output-md artifacts/current.md

Compare against a baseline and fail CI on regressions above 5%:

uv run benchbro run my_benchmarks.py \
  --baseline-json artifacts/baseline.json \
  --fail-on-regression 5

Compare two saved runs directly:

uv run benchbro compare artifacts/baseline.json artifacts/current.json --fail-on-regression 5

End-to-end example

For a complete runnable workflow (baseline, candidate, and compare), use:

• examples/README.md
• make examples