Skip to main content

reverie-schema (Python)

Pydantic v2 models for the Reverie CognitiveEvent schema (v1.0). This is the canonical Python definition used by:

  • reverie-adapter-openai — for emitting events
  • reverie-api — for validating events on ingress

The wire format is camelCase JSON, identical to the TypeScript schema in @reverie/schema. Internally, Python code uses snake_case field names; the Pydantic models translate via alias_generator=to_camel.

Usage

from reverie_schema import CognitiveEvent, GoalPayload

event = CognitiveEvent(
    type="goal.created",
    run_id="...",
    session_id="...",
    agent_id="my-agent",
    payload=GoalPayload(intent="...", priority="high", context=""),
)

# Wire serialization (camelCase, ready for HTTP / DB):
event.model_dump_json()

# Inbound validation (raises ValidationError on failure):
CognitiveEvent.model_validate_json(raw_json)

Install (editable, dev)

uv pip install -e ".[dev]"
pytest

Release files for reverie-schema 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for reverie-schema 0.1.0
File Size Uploaded
reverie_schema-0.1.0.tar.gz 9.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for reverie-schema 0.1.0
File Interpreter ABI Platform
reverie_schema-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 15.3 kB

Release files / reverie_schema-0.1.0.tar.gz

Download URL reverie_schema-0.1.0.tar.gz
Size 9.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d953fb6cc735f924e3f84dba0e77983d75374c52ac10e7dd4aef5c7302f92446
BLAKE2b-256 checksum
How to use checksums
d54c12860368b942a1d896408a24fb291fef0586c45a7951e63b5b6669d1dd20
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / reverie_schema-0.1.0-py3-none-any.whl

Download URL reverie_schema-0.1.0-py3-none-any.whl
Size 5.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6b3f250de435e3b56c3cb4d6740b738bb445e9f4d3b88f93a22929999be3da86
BLAKE2b-256 checksum
How to use checksums
308793efb72a57d6e806fa5d517366c9763c452f8187d9f2b16cdfd8e229eea7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page