scitex-events

Zero-dep async event bus for the SciTeX ecosystem.

Full Documentation · uv pip install scitex-events[all]

Quick Start

import scitex_events as ev

ev.emit("test_complete", project="figrecipe", status="success",
        payload={"exit_code": 0, "module": "stats"})

ev.latest("test_complete")     # most recent event of this type
list(ev.history(limit=20))     # recent history

Demo

flowchart LR
    Producer[ev.emit] --> JSONL[(JSONL store)]
    JSONL --> Latest[ev.latest]
    JSONL --> History[ev.history]
    JSONL -. optional .-> Webhook[Cloud webhook]

_{Figure 1. Demo path. One emit call lands in the JSONL store and is immediately readable via latest/history.}

Installation

uv pip install "scitex-events[all]"

uv pip install -e ".[dev]"               # editable install for contributors

flowchart LR
    Emit[ev.emit] --> Schema[_schema.Event]
    Schema --> Store[(JSONL store)]
    Store --> Latest[ev.latest]
    Store --> History[ev.history]
    Store -. optional .-> Webhook[webhook delivery]
    Registry[_types registry] --> Info[ev.list_types / get_type_info]

_{Figure 2. Event flow. Emission validates against the schema, appends to the local JSONL store, and fans out to readers plus an optional webhook.}

1 Interfaces

import scitex_events as ev

# Emit an event (any kwargs become payload fields).
ev.emit("test_complete", project="figrecipe", status="success",
        payload={"exit_code": 0, "module": "stats"})

# Latest event of a given type.
ev.latest("test_complete")

# Recent history (newest first).
list(ev.history(limit=20))

# Schemas / introspection.
ev.list_types()
ev.get_type_info("test_complete")

Status

Standalone fork of scitex.events. Pure stdlib — zero runtime deps except scitex-config (canonical local-state directory resolver per the SciTeX local-state directories skill). The umbrella package's scitex.events import path is preserved via a sys.modules-alias bridge so existing code continues to work.

Part of SciTeX

scitex-events is part of SciTeX. Install via the umbrella with pip install scitex[events] to use as scitex.events (Python) or scitex events ... (CLI).

Four Freedoms for Research

0. The freedom to run your research anywhere — your machine, your terms.
1. The freedom to study how every step works — from raw data to final manuscript.
2. The freedom to redistribute your workflows, not just your papers.
3. The freedom to modify any module and share improvements with the community.

AGPL-3.0 — because we believe research infrastructure deserves the same freedoms as the software it runs on.

License

AGPL-3.0-only (see LICENSE).