Skip to main content

Briefcase AI SDK

License: Apache-2.0

Governance infrastructure for AI decisions: enforce controls, record context, replay later.

Install

pip install briefcase-ai

Quick Example

import briefcase

briefcase.observe("console")          # send records to stderr (or "memory" / "runs.jsonl")

@briefcase.capture(decision_type="classify_text")
def classify(text: str) -> str:
    return text.upper()

classify("hello world")               # a decision record is emitted

capture works immediately — no briefcase.init() required. Call init() only when you use the native runtime features (storage backends, snapshots). Without a call to briefcase.observe(...) (or briefcase.setup(exporter=...)), @capture records decisions but has nowhere to send them.

Exporters. briefcase.observe(...) accepts "console", "memory" (records collected on exporter.records), a "*.jsonl" path, or any briefcase.exporters.BaseExporter instance — subclass BaseExporter to ship records to your own backend.

Evaluations and RL

Two bridges emit decision records from work that is not a single function call. Both use the exporter you already configured.

from briefcase.integrations.evals import EvalRun, from_inspect_log, replay

with EvalRun("gsm8k", model="claude-opus-5") as run:   # one eval.case per case,
    run.log_case("q1", inputs=q, outputs=a, passed=a == target)   # one eval.run
print(run.summary()["pass_rate"])

replay(from_inspect_log("logs/2026-08-12_gsm8k.eval"))  # inspect-ai .json/.eval

The parsers are stdlib only and never import the eval framework, so a log can be replayed on a machine that has neither installed. See examples/eval_runs/.

from briefcase.integrations.gym import GuardrailGymEnv, capture_episodes

env = GuardrailGymEnv(guardrail, tasks, injections)  # a guardrail as a gym.Env
env = capture_episodes(env)                          # rl.step / rl.episode records

Needs pip install briefcase-ai[gym]. See examples/rl_gym/.

capture_episodes exports on a background thread by default, since step capture is on the hot path. A script that exits right after close() can lose its records; pass capture_episodes(env, async_capture=False) in short runs. EvalRun already defaults to async_capture=False for that reason.

Logging

The library is silent by default (it installs only a NullHandler). Turn on visible logs explicitly:

import briefcase
briefcase.enable_logging("DEBUG")     # or set BRIEFCASE_LOG_LEVEL=DEBUG

Using with AI tools (Cursor, Claude Code, Codex, …)

This repo ships machine-readable usage guidance: llms.txt / llms-full.txt, an AGENTS.md, and copy-paste editor rules under docs/llm/. An MCP server is available via pip install briefcase-ai[mcp] then briefcase-mcp.

Extras

Extra Description
replay Deterministic replay engine for recorded decisions
drift Drift scoring and cost calculation for model outputs
sanitize Built-in PII redaction utilities
otel OpenTelemetry helpers
storage Rust-backed SQLite storage engine
validate Prompt validation engine
guardrails Guardrail framework, wrappers, and registries
rag Versioned embedding pipeline and instrumented retrieval
rag-chroma / rag-pinecone / rag-weaviate Vector-store adapters (each adds its client)
correlation Workflow and trace correlation helpers
external External data snapshot tracking
events Structured event type and emitter interface
kafka / webhook / gcp-logging Event transports and the Cloud Logging exporter (webhook is stdlib)
routing Router protocol, agent router, versioned policy registry
opa OPA HTTP router with cached decisions and internal-router fallback (adds httpx)
lakefs lakeFS versioned storage client, branch manager, lineage, staged commits
vcs VCS client base protocol plus DVC, Nessie, Pachyderm, ArtiVC, DuckLake, Iceberg, and git-LFS adapters
vcs-dvc / vcs-pachyderm / vcs-ducklake / vcs-iceberg Per-provider VCS clients (the rest are HTTP/subprocess based)
gym Gymnasium bridge: guardrail env adapter and RL episode capture
evals Eval-harness bridge: EvalRun logger, inspect-ai / lm-eval parsers (adds zstandard for .eval archives on Python < 3.14)
bitemporal Bitemporal evidence store, as-of views, append-only corrections
bitemporal-iceberg pyiceberg-backed bitemporal store (any supported catalog)
bitemporal-glue AWS Glue catalog auth for the Iceberg backend (adds boto3)
kdb kdb+ bitemporal backend (adds KX-licensed pykx; excluded from all)
compliance Examiner bundles joining decision, evidence, and policy version
compliance-kms KMS-signed examiner bundles against your own AWS KMS key (adds boto3)
controls Gateway, quota, throttle classification, and retry (no extra dependencies)
langchain / crewai / llamaindex / autogen / ag2 / pageindex / openai-agents Framework auto-instrumentation via briefcase.auto (each adds its framework)
mcp MCP server (briefcase-mcp) exposing the SDK to AI agents
dev Dev tooling: pytest, mypy, flake8, moto
all Installs every optional extra listed above except kdb

Most features are native- or pure-Python-backed and ship with the base package — their extras (replay, drift, sanitize, storage, routing, bitemporal, compliance, …) are convenience groupings that pull in no additional dependencies. The extras that install third-party packages are otel, lakefs, bitemporal-iceberg, bitemporal-glue, kdb, compliance-kms, gym, evals, mcp, opa, kafka, gcp-logging, the rag-* and vcs-* store adapters, and the framework auto-instrumentation extras.

Managed platform

Every library feature runs against infrastructure you own: storage backends (in-memory, SQLite, pyiceberg, Glue-authenticated Iceberg, kdb+), KMS-signed examiner bundles, guardrails, RBAC/ABAC/OPA policy evaluation, routing, replay, framework auto-instrumentation (briefcase.auto), lakeFS branching and lineage, vector-store and VCS adapters, event transports, and the controls layer, in both Python and TypeScript (@briefcase-ai/controls).

The commercial offering is the hosted platform, not gated code: a managed control plane, catalog provisioning and credential brokering, operational runbooks (DR failover, catalog migration, key rotation), certified retention and regulator attestations, licensed market-data ingest (Bloomberg BPIPE, Refinitiv, ICE), and SOC 2 / FedRAMP posture with SLA support.

Contact sales@briefcasebrain.com for the managed platform.

Telemetry

The SDK can report anonymous usage metrics (SDK version, OS, architecture, backend type) to help prioritize development. No personal data or decision content is ever collected. Telemetry is only transmitted when a collection endpoint is configured via BRIEFCASE_API_URL (it defaults to localhost, i.e. a no-op), and you can disable it entirely at any time:

export BRIEFCASE_TELEMETRY=0   # also accepts: false, no, off (case-insensitive)

Links

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

briefcase_ai-4.2.0.tar.gz (323.0 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

briefcase_ai-4.2.0-cp39-abi3-win_amd64.whl (7.6 MB view details)

Uploaded CPython 3.9+Windows x86-64

briefcase_ai-4.2.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (8.3 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ x86-64

briefcase_ai-4.2.0-cp39-abi3-macosx_11_0_arm64.whl (7.8 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

briefcase_ai-4.2.0-cp39-abi3-macosx_10_12_x86_64.whl (7.9 MB view details)

Uploaded CPython 3.9+macOS 10.12+ x86-64

File details

Details for the file briefcase_ai-4.2.0.tar.gz.

File metadata

  • Download URL: briefcase_ai-4.2.0.tar.gz
  • Upload date:
  • Size: 323.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.14

File hashes

Hashes for briefcase_ai-4.2.0.tar.gz
Algorithm Hash digest
SHA256 f0c6fc484f99ca9e8fc9869283519bd76e7121e5395784490c63ea4d42a1fbb5
MD5 814624bf1e9fc742cfdfc9396947b013
BLAKE2b-256 3a35fcddc53662bb3cbeeb896ba87845837a782c578bb92a35f320a63c83b788

See more details on using hashes here.

File details

Details for the file briefcase_ai-4.2.0-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: briefcase_ai-4.2.0-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 7.6 MB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for briefcase_ai-4.2.0-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 087962860116af9b4bdb5db5de817c24dd7e3c8062b2dcad74603062f59b81e6
MD5 9c01d11b1f2ca03ff2a6b82b0396eb70
BLAKE2b-256 ed4bc2334fee52787f7cb33204d91dd82696b5f683cde7015520596f6fc528ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for briefcase_ai-4.2.0-cp39-abi3-win_amd64.whl:

Publisher: publish.yml on briefcasebrain/briefcase-ai-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file briefcase_ai-4.2.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for briefcase_ai-4.2.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 28d5bd429ee245749f3b08d861c38b516b9377198ca95da38560f5f064e5c991
MD5 3f3a6b887bf67dc2ce098ed755c5c99f
BLAKE2b-256 d9f182ce945dcb0f318f0a9b6aded2aeb02702ce6bd4ec54be7f03e48c3d188a

See more details on using hashes here.

Provenance

The following attestation bundles were made for briefcase_ai-4.2.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: publish.yml on briefcasebrain/briefcase-ai-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file briefcase_ai-4.2.0-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for briefcase_ai-4.2.0-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 79ac677fafd1c5433b75987efc3e415f03d768e38e36cdabc3a3e76325f3f841
MD5 b70a431c5876cb8d2fbc303b6651271b
BLAKE2b-256 0d52cac925d4ad1ec9cae7c98fe4620f61523307dca9bb3a28ece458c3e4192b

See more details on using hashes here.

File details

Details for the file briefcase_ai-4.2.0-cp39-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for briefcase_ai-4.2.0-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 be717c9b8f186421839793a68f96b970b99fcdc25c3f531c010aaa93c7ccaa6a
MD5 afe8d44d555a2177b46811ac07265e8f
BLAKE2b-256 78d43a10fc4f0dda7ebbb2e800ad8783bcdc3f27dd9c3304c13b6e61854660c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for briefcase_ai-4.2.0-cp39-abi3-macosx_10_12_x86_64.whl:

Publisher: publish.yml on briefcasebrain/briefcase-ai-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page