Skip to main content

Build PyPi Documentation

Introduction

The primary use cases of eventkit are

  • to send events between loosely coupled components;

  • to compose all kinds of event-driven data pipelines.

The interface is kept as Pythonic as possible, with familiar names from Python and its libraries where possible. For scheduling asyncio is used and there is seamless integration with it.

See the examples and the introduction notebook to get a true feel for the possibilities.

Note: the package is published as aeventkit and imported as eventkit.

Installation

pip install aeventkit

pip install aeventkit[numpy]  # with the Array operators

Python 3.11 or later is required (tested on CPython 3.11 to 3.15 and PyPy 3.11).

Upgrading from 2.x? See Upgrading to 3.0 and the changelog.

Examples

Create an event and connect two listeners

import eventkit as ev

def f(a, b):
    print(a * b)

def g(a, b):
    print(a / b)

event = ev.Event()
event += f
event += g
event.emit(10, 5)

Create a simple pipeline

import eventkit as ev

event = (
    ev.Sequence('abcde')
    .map(str.upper)
    .enumerate()
)

print(event.run())  # in Jupyter: await event.list()

Output:

[(0, 'A'), (1, 'B'), (2, 'C'), (3, 'D'), (4, 'E')]

Create a pipeline to get a running average and standard deviation

(with the numpy extra: pip install aeventkit[numpy])

import random
import eventkit as ev

source = ev.Range(1000).map(lambda i: random.gauss(0, 1))

event = source.array(500)[ev.ArrayMean, ev.ArrayStd].zip()

print(event.last().run())  # in Jupyter: await event.last()

Output:

[(0.00790957852672618, 1.0345673260655333)]

Combine async iterators together

import asyncio
import eventkit as ev

async def ait(r):
    for i in r:
        await asyncio.sleep(0.1)
        yield i

async def main():
    async for t in ev.Zip(ait('XYZ'), ait('123')):
        print(t)

asyncio.run(main())  # in Jupyter: await main()

Output:

('X', '1')
('Y', '2')
('Z', '3')

Real-time video analysis pipeline

self.video = VideoStream(conf.CAM_ID)
scene = self.video | FaceTracker | SceneAnalyzer
lastScene = scene.aiter(skip_to_last=True)
async for frame, persons in lastScene:
    ...

Full source code

Parallel processing

poolmap runs a function on the values of an event in a concurrent.futures executor: a process pool for CPU-bound work on all cores, an interpreter pool (Python 3.14+), or a thread pool for blocking I/O. Results stay in order unless ordered=False, and chunksize batches small tasks:

import bz2
from concurrent.futures import ProcessPoolExecutor

import eventkit as ev

if __name__ == "__main__":
    data = [b"A" * 1_000_000] * 1000
    with ProcessPoolExecutor() as pool:
        sizes = ev.Sequence(data).poolmap(pool, bz2.compress, chunksize=10).map(len)
        print(sizes.mean().last().run())

Inspired by:

Documentation

The complete API documentation.

Metadata

Release files for aeventkit 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aeventkit 3.0.0
File Size Uploaded
aeventkit-3.0.0.tar.gz 33.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aeventkit 3.0.0
File Interpreter ABI Platform
aeventkit-3.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 70.3 kB

Release files / aeventkit-3.0.0.tar.gz

Download URL aeventkit-3.0.0.tar.gz
Size 33.5 kB
Tags Source
SHA-256 checksum
How to use checksums
16616fef98ba04aec6de8ea5e66b3cd0ad99a4de8f57a3878bff43d1dfb31ea2
BLAKE2b-256 checksum
How to use checksums
97324e13bc9727183e4d4878953a302d36154fc6283dd726c4ce1e91188469b8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / aeventkit-3.0.0-py3-none-any.whl

Download URL aeventkit-3.0.0-py3-none-any.whl
Size 36.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b36c54ca7ca6393ce48312568ea5e7b58003af0669abf1c700bba3ce16fd1d1b
BLAKE2b-256 checksum
How to use checksums
e9ecc1783542a0e752547a7a3da4627c483ebe2648e6e98141c877e349c453f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

3.0.0 This release

2 release files

2.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page