Metadata-Version: 2.4
Name: boei
Version: 0.1.2
Summary: Boei runtime SDK and OpenTelemetry instrumentation for AI systems
Project-URL: Homepage, https://github.com/Boei-AI/boei
Project-URL: Issues, https://github.com/Boei-AI/boei/issues
Author-email: Ishaan Dhillon <ishaan@boei.ai>
License: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: aiohttp<4.0.0,>=3.8.0
Requires-Dist: opentelemetry-api<2.0.0,>=1.29.0; python_version >= '3.10'
Requires-Dist: opentelemetry-api==1.29.0; python_version < '3.10'
Requires-Dist: opentelemetry-exporter-otlp-proto-http<2.0.0,>=1.29.0; python_version >= '3.10'
Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.29.0; python_version < '3.10'
Requires-Dist: opentelemetry-instrumentation<1.0.0,>=0.50b0; python_version >= '3.10'
Requires-Dist: opentelemetry-instrumentation==0.50b0; python_version < '3.10'
Requires-Dist: opentelemetry-sdk<2.0.0,>=1.29.0; python_version >= '3.10'
Requires-Dist: opentelemetry-sdk==1.29.0; python_version < '3.10'
Requires-Dist: opentelemetry-semantic-conventions<1.0.0,>=0.50b0; python_version >= '3.10'
Requires-Dist: opentelemetry-semantic-conventions==0.50b0; python_version < '3.10'
Requires-Dist: packaging<25.0,>=21.0
Requires-Dist: requests<3.0.0,>=2.0.0
Requires-Dist: termcolor<2.5.0,>=2.3.0
Requires-Dist: wrapt<2.0.0,>=1.0.0
Description-Content-Type: text/markdown

# Boei Runtime SDK

The Boei Python SDK captures runtime metadata for AI systems and sends it to
Boei's runtime ingest API. Install it:

```bash
pip install boei
```

Then import and initialize:

```python
import boei

boei.init()
```

## Activation

Use a managed project key from Boei:

```bash
export BOEI_API_KEY="boei_pk_..."
```

The SDK exchanges the project key for a runtime token at `/v1/auth/token` and
sends telemetry to `/v1/runtime/ingest` or `/v1/traces`. There is no Boei CLI in this story; activation is SDK install plus project key configuration.

## Privacy Default

Boei does not read prompt or response content by default.

```bash
export BOEI_CAPTURE_CONTENT=false
```

That is also the default when the variable is unset. The legacy
`TRACELOOP_TRACE_CONTENT` variable does not turn Boei content capture on.

If a tenant deliberately opts in:

```bash
export BOEI_CAPTURE_CONTENT=true
```

the SDK still runs redaction for common PII and secret patterns before export.
The ingest API also strips prompt/message attributes unless the runtime token
carries `capture_content=true`.

## What Runtime Proves

Runtime evidence can corroborate:

- call volume
- token counts
- provider
- model choice
- SDK-estimated runtime cost under a project key

Runtime evidence cannot prove:

- provider bill-of-record spend
- system ownership
- a confirmed AI system
- control effectiveness
- prompt or response content when content capture is off

Runtime rollups become `source_evidence_atoms` as pending key observations.
They stay corroborator evidence until later scanner binding and reviewer
confirmation work.
