https://github.com/dboslee/evently
A super lightweight event bus for python
https://github.com/dboslee/evently
async asyncio eventbus events hacktoberfest message-broker message-bus messaging pubsub python
Last synced: 3 months ago
JSON representation
A super lightweight event bus for python
- Host: GitHub
- URL: https://github.com/dboslee/evently
- Owner: dboslee
- License: mit
- Created: 2020-09-05T22:21:37.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-10-02T15:21:59.000Z (about 4 years ago)
- Last Synced: 2025-04-18T04:56:32.607Z (7 months ago)
- Topics: async, asyncio, eventbus, events, hacktoberfest, message-broker, message-bus, messaging, pubsub, python
- Language: Python
- Homepage:
- Size: 8.79 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Evently [](https://travis-ci.com/dboslee/evently)
A lightweight event bus for python asyncio
**About Evently**:
- Written in python3.8
- Built around asynio
- Uses type hinting
- Simple API
- Threadsafe
### How to install
`pip install evently`
### Dev environment setup
```
# Clone the repository.
git clone https://github.com/dboslee/evently
cd evently
# Setup virtualenv
pip3 install virtualenv
python3 -m virtualenv env
source env/bin/activate
# Run tests.
python -m unittest discover -p test_*.py
```
### Code Examples
Here is a complete example
```
import asyncio
from evently import Evently, Event
loop = asyncio.get_event_loop()
evently = Evently(loop)
@evently.subscribe("hello")
async def say_world(event: Event):
print("world")
async def main():
evently.publish("hello")
await asyncio.sleep(0)
loop.run_until_complete(main())
```
Pass data along with an event and access it with `event.event_data`
```
@evently.subscribe("hello")
def say_world(event):
print(event.event_type)
print(event.event_data)
print("world")
evently.publish("hello", {"example": "data"})
```
Subscribe to the same event many times
```
@evently.subscribe("hello")
def say_world(event):
print("world")
@evently.subscribe("hello")
def say_goodbye(event):
print("goodbye")
```
Subscribe to multiple events
```
@evently.subscribe(["hello", "hola"])
def say_world(event):
if event.event_type == "hello":
print("world")
elif event.event_type == "hola":
print("mundo")
```
Unsubscribe when you no longer want a handler to be called
```
@evently.subscribe("hello")
def say_world(event):
print("world")
say_world.unsubscribe()
```
Run blocking code in an executor with the kwarg `blocking=True`
```
from time import sleep
@evently.subscribe("hello", blocking=True)
def say_world_blocking(event):
sleep(10)
print("world")
```
Receive the EventHandler instance as a kwarg by using `context=True`
```
from time import sleep
@evently.subscribe("hello", context=True)
def say_world_blocking(event, context):
sleep(10)
print("world")
context.unsubscribe()
```