ZeroMQ Distributed EventBus for Python
Project description
A Distributed Eventbus using ZeroMQ and AsyncIO for Python.
The objective of this library is to provide both a local and distributed eventbus that are compatible to communicate. A similar API can be used in both versions of the eventbuses implementations.
Installation
For installing the package, download from PyPI and install with pip
:
pip install aiodistbus
Here is a link to the Documentation. If you encounter any issues in terms of code or documentation, please don't hesitate to make an issue.
EventBus Example
The eventbus implementation follows a client-server design approach, with the DEventBus
as the server and DEntryPoint
as the client. Here is a quick example to emit an event.
import asyncio
from dataclasses import dataclass
from dataclasses_json import DataClassJsonMixin # DO NOT FORGET THIS!
import aiodistbus as adb
@dataclass
class ExampleEvent(DataClassJsonMixin): # NEEDS TO BE A DataClassJsonMixin!
msg: str
async def handler(event: ExampleEvent):
print(event)
async def main():
# Create resources
bus, e1, e2 = adb.DEventBus(), adb.DEntryPoint(), adb.DEntryPoint()
# Connect
await e1.connect(bus.ip, bus.port)
await e2.connect(bus.ip, bus.port)
# Add funcs
await e1.on("test", handler, ExampleEvent)
# Send message
await e2.emit("test", ExampleEvent("hello"))
# Flush
await bus.flush()
# Close resources
await e1.close()
await e2.close()
await bus.close()
if __name__ == '__main__':
asyncio.run(main())
Design
In the aiodistbus
library, we provided 2 eventbus implementations: EventBus
and DEventBus
. The EventBus
class is for local (within same Python runtime) observer pattern. In the other hand, DEventBus
class is for a distributed eventbus that leverages ZeroMQ -- closing following the Clone pattern.
The Clone pattern uses a client-server structure, where a centralized broker broadcasts messages sent by clients. As described in the ZeroMQ Guide, this creates a single point of failure, but yields in a simpler and more scalable implementation.
Contributing
Contributions are welcomed! Our Developer Documentation should provide more details in how ChimeraPy works and what is in current development.
License
ChimeraPy and ChimeraPy/aiodistbus uses the GNU GENERAL PUBLIC LICENSE, as found in LICENSE file.
Funding Info
This project is supported by the National Science Foundation under AI Institute Grant No. DRL-2112635.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aiodistbus-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b768335b100d71ac9ed16f4a24ee2659bf9342bd75451bdce4450bff5eba5b6c |
|
MD5 | 760e49824d7c28cf7d5869adda580bf9 |
|
BLAKE2b-256 | 54b4e5b5a16d292a6a791aa7b1f756f19ecf540209d5ea994a7ccd7a46d6f2b4 |