Skip to main content

Reverie backend — FastAPI event ingestion + SQLite append-only log

Project description

reverie-api

The Reverie ingestion backend. FastAPI on top of SQLite, with append-only event storage and a WebSocket fan-out for live subscribers.

Endpoints (Phase 0)

Method Path Purpose
GET /health Liveness check
POST /api/v1/runs Create a run
GET /api/v1/runs List runs (paginated)
GET /api/v1/runs/{run_id} Get one run
PATCH /api/v1/runs/{run_id} Update status / completedAt / goal
DELETE /api/v1/runs/{run_id} Delete run + cascade events (refused if pinned)
PATCH /api/v1/runs/{run_id}/pin Pin / unpin a run
GET /api/v1/runs/{run_id}/events Get all events for a run, in timestamp order
POST /api/v1/events Ingest one event
POST /api/v1/events/batch Ingest up to 1000 events atomically
WS /stream?runId=<id> Live event stream for one run

Configuration

Environment variables (all optional, prefix REVERIE_):

Var Default Description
REVERIE_DB_PATH data/reverie.db SQLite file path
REVERIE_HOST 127.0.0.1 Bind host
REVERIE_PORT 8000 Bind port
REVERIE_CORS_ORIGINS http://localhost:3000 Comma-separated allowed origins
REVERIE_ENV development Environment label

Run

uv pip install --python ../../.venv/Scripts/python.exe -e ".[dev]"
python -m reverie_api

Then visit http://localhost:8000/docs for the OpenAPI UI.

Test

pytest

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

reverie_api-0.1.0-py3-none-any.whl (697.4 kB view details)

Uploaded Python 3

File details

Details for the file reverie_api-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: reverie_api-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 697.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for reverie_api-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4de583d6b2bec9aa22502886c8f23e25b055ee76a418aea9f6986db2ad38576b
MD5 e665c01f7ab8275d33fcdcda5e6e4996
BLAKE2b-256 ddf18ccf1853533a4218b2fb9f2087c4f5c7d72f30182c6d8d9483fccbc586da

See more details on using hashes here.

Supported by

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