serialize-foundation-sdk 0.1.0

Python client SDK for the serialize Foundation audit ledger

serialize-foundation-sdk (Python)

Python client SDK for the serialize Foundation audit ledger. Mirrors @serializefoundation/foundation-sdk-ts.

Install

pip install serialize-foundation-sdk

Or in editable mode from the monorepo:

pip install -e "packages/foundation-sdk-py[dev]"

Quick start

from serialize_foundation_sdk import FoundationClient, SerialisedEventInput, Subject

client = FoundationClient(
    api_key="your-api-key",
    base_url="https://foundation.serialize.local",
)

# Record an event — actor + tenantId are resolved server-side from your API key
event = client.record_event(
    SerialisedEventInput(
        schema_version=1,
        action="create",
        subject=Subject(
            document_id="doc-001",
            version_hash="a" * 64,  # SHA-256 of document content
            document_type="swms",
        ),
    )
)
print(event.event_id)

client.close()

See CLAUDE.md for full API reference, conventions, and ADR links. See docs/adr/0005-actor-profile-system.md for why actor/tenantId are excluded from input.