Metadata-Version: 2.4
Name: scitex-events
Version: 0.1.1
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: ruff; 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

<!-- scitex-badges:start -->
[![PyPI](https://img.shields.io/pypi/v/scitex-events.svg)](https://pypi.org/project/scitex-events/)
[![Python](https://img.shields.io/pypi/pyversions/scitex-events.svg)](https://pypi.org/project/scitex-events/)
[![Tests](https://github.com/ywatanabe1989/scitex-events/actions/workflows/test.yml/badge.svg)](https://github.com/ywatanabe1989/scitex-events/actions/workflows/test.yml)
[![Install Test](https://github.com/ywatanabe1989/scitex-events/actions/workflows/install-test.yml/badge.svg)](https://github.com/ywatanabe1989/scitex-events/actions/workflows/install-test.yml)
[![Coverage](https://codecov.io/gh/ywatanabe1989/scitex-events/graph/badge.svg)](https://codecov.io/gh/ywatanabe1989/scitex-events)
[![Docs](https://readthedocs.org/projects/scitex-events/badge/?version=latest)](https://scitex-events.readthedocs.io/en/latest/)
[![License: AGPL v3](https://img.shields.io/badge/license-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
<!-- scitex-badges:end -->


General-purpose async event bus extracted from the [SciTeX](https://github.com/ywatanabe1989/scitex-python) ecosystem as a standalone, zero-dep package.

## Install

```bash
pip install scitex-events
```

## Usage

```python
import scitex_events as ev

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

# Read latest event of a given type
ev.latest("test_complete")
# {"type": "test_complete", "project": "figrecipe", ...}

# Recent history
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.

## 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.

## License

AGPL-3.0-only (see [LICENSE](./LICENSE)).
