Metadata-Version: 2.5
Name: streamoid
Version: 0.1.1
Summary: Streamoid platform SDK (L1): event envelope, C6 object keys, C3 secrets, analytics/audit capture, files index, MCP self-registration.
Requires-Python: >=3.10
Requires-Dist: httpx>=0.25.0
Description-Content-Type: text/markdown

# streamoid (Python)

The Python port of the streamoid platform SDK. See the [repo root README](../README.md)
for the full picture (why this exists, the other language ports, versioning).

## Install

From [public PyPI](https://pypi.org/project/streamoid/) — no token, and no read
access to this (private) repo:

```bash
uv add streamoid
```

Or `pip install streamoid`. If you are migrating a service off the old
`git+https://.../streamoid-sdk` dependency, drop its `[tool.uv.sources]`
`streamoid` entry as well as the dependency line — and check for a
`requirements.txt` alongside the `pyproject.toml`, which carries its own copy of
the dependency rather than being generated from it.

## Usage

```python
from streamoid import capture, record_file, register_mcp_server, build_object_key, StoredFile

await capture(
    "file_uploaded",
    actor={"user_id": uid},
    tenant={"workspace_id": ws},
    properties={"kind": "file-upload", "size": size},
)
```

Every consuming service must set `STREAMOID_PRODUCT` in its environment — there is
no hardcoded per-service default (see `src/streamoid/config.py`'s module docstring
for why).

## Tests

```bash
uv run pytest
```
