Skip to main content

General-purpose async event bus (file-backed, JSON Lines) — standalone module from the SciTeX ecosystem

Project description

scitex-events

SciTeX

Zero-dep async event bus for the SciTeX ecosystem.

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

PyPI Python Tests Coverage Docs License: AGPL v3


Installation

pip install scitex-events

Architecture

scitex-events/
├── src/scitex_events/
│   ├── _emit.py         # write event to JSONL store
│   ├── _history.py      # latest / history / list_types
│   ├── _schemas.py      # event-type registry
│   └── _webhook.py      # optional cloud forwarder
└── tests/

1 Interfaces

Python API
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")

Events are stored locally as JSON-Lines files (override path via SCITEX_EVENTS_DIR) and can optionally be forwarded to a cloud webhook.

Demo

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

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

Status

Standalone fork of scitex.events. Pure stdlib — zero runtime deps. 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

  1. The freedom to run your research anywhere — your machine, your terms.
  2. The freedom to study how every step works — from raw data to final manuscript.
  3. The freedom to redistribute your workflows, not just your papers.
  4. 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).


SciTeX

Project details


Download files

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

Source Distribution

scitex_events-0.1.5.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

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

scitex_events-0.1.5-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file scitex_events-0.1.5.tar.gz.

File metadata

  • Download URL: scitex_events-0.1.5.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_events-0.1.5.tar.gz
Algorithm Hash digest
SHA256 2206743733c20eda90765f27089c373e96dada691f8efa349a51ab39a1db0cdc
MD5 26633b17f301a8434fc8afab3c7b1c71
BLAKE2b-256 9eeae42103e2af5248acfb84e1e4b82ec14308433f4b0057c8fb8e6b082d6ef2

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_events-0.1.5.tar.gz:

Publisher: pypi-publish-and-github-release-on-tag.yml on ywatanabe1989/scitex-events

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scitex_events-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: scitex_events-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 22.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_events-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4b49888983123ac02e408f475849ee90a36221d0dd6d13cbfc460022f8187055
MD5 0507c9bad0c426170d96c2f941e561de
BLAKE2b-256 9462fee07958bcc0342658eecb5827c55ecb03b82b6fcff5ff6fdfc13dda5fd9

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_events-0.1.5-py3-none-any.whl:

Publisher: pypi-publish-and-github-release-on-tag.yml on ywatanabe1989/scitex-events

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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