Metadata-Version: 2.4
Name: scitex-events
Version: 0.1.7
Summary: General-purpose async event bus (file-backed, JSON Lines) — standalone module from the SciTeX ecosystem
Author-email: Yusuke Watanabe <ywatanabe@scitex.ai>
License-Expression: AGPL-3.0-only
Project-URL: Homepage, https://github.com/ywatanabe1989/scitex-events
Project-URL: Repository, https://github.com/ywatanabe1989/scitex-events
Project-URL: Documentation, https://scitex-events.readthedocs.io
Keywords: scitex,events,event-bus,telemetry,monitoring
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: scitex-config>=0.3.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-timeout; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: scitex-dev[cli-audit]>=0.11.7; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
Requires-Dist: myst-parser>=2.0; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=1.25; extra == "docs"
Provides-Extra: all
Requires-Dist: scitex-events[dev,docs]; extra == "all"
Dynamic: license-file

# scitex-events

<p align="center">
  <a href="https://scitex.ai">
    <img src="docs/scitex-logo-blue-cropped.png" alt="SciTeX" width="400">
  </a>
</p>

<p align="center"><b>Zero-dep async event bus for the SciTeX ecosystem.</b></p>

<p align="center">
  <a href="https://scitex-events.readthedocs.io/">Full Documentation</a> · <code>uv pip install scitex-events[all]</code>
</p>

<!-- scitex-badges:start -->
<p align="center">
  <a href="https://pypi.org/project/scitex-events/"><img src="https://img.shields.io/pypi/v/scitex-events?label=pypi" alt="pypi"></a>
  <a href="https://pypi.org/project/scitex-events/"><img src="https://img.shields.io/pypi/pyversions/scitex-events?label=python" alt="python"></a>
  <a href="https://github.com/scitex-ai/scitex-events/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/scitex-ai/scitex-events/ci.yml?branch=develop&label=docs" alt="docs"></a>
  <a href="https://scitex-events.readthedocs.io/en/latest/"><img src="https://img.shields.io/readthedocs/scitex-events?label=docs" alt="docs-rtd"></a>
</p>
<p align="center">
  <a href="https://github.com/scitex-ai/scitex-events/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/scitex-ai/scitex-events/ci.yml?branch=develop&label=tests" alt="tests"></a>
  <a href="https://github.com/scitex-ai/scitex-events/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/scitex-ai/scitex-events/ci.yml?branch=develop&label=install-check" alt="install-check"></a>
  <a href="https://codecov.io/gh/scitex-ai/scitex-events"><img src="https://img.shields.io/codecov/c/github/scitex-ai/scitex-events/develop?label=cov" alt="cov"></a>
</p>
<!-- scitex-badges:end -->

---

## Quick Start

```python
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

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

<p align="center"><sub><b>Figure 1.</b> Demo path. One emit call lands in the JSONL store and is immediately readable via latest/history.</sub></p>

## Installation

```bash
uv pip install "scitex-events[all]"
```

<details>
<summary><b>Per-module extras</b></summary>

<br>

| Extra | Pulls in |
|---|---|
| `all` | `dev` + `docs` (recommended) |
| `dev` | pytest, pytest-cov, pytest-timeout, ruff |
| `docs` | Sphinx + RTD theme + myst-parser (docs build only) |

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

</details>
## Architecture

```mermaid
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]
```

<p align="center"><sub><b>Figure 2.</b> Event flow. Emission validates against the schema, appends to the local JSONL store, and fans out to readers plus an optional webhook.</sub></p>

## 1 Interfaces

<details open>
<summary><strong>Python API</strong></summary>

<br>

```python
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 under `~/.scitex/events/runtime/`
(resolved via `local_state.runtime_path("events")`) and can optionally be forwarded
to a cloud webhook.

</details>

## 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**](https://scitex.ai). 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](./LICENSE)).

---

<p align="center">
  <a href="https://scitex.ai" target="_blank"><img src="docs/scitex-icon-navy-inverted.png" alt="SciTeX" width="40"/></a>
</p>
