Eventipy

eventipy is an in-memory event library for python 3.6 and greater.

Getting Started

To install:

pip install eventipy

For full documentation please visit: https://eventipy.readthedocs.io/en/stable/

Usage

Publishing events:

import asyncio
from eventipy import events, Event

event = Event(topic="my-topic")
asyncio.run(events.publish(event))

Subscribing to topics:

from eventipy import events, Event

@events.subscribe("my-topic")
def event_handler(event: Event):
    # Do something with event
    print(event.id)

now every time an event with topic my-topic is published, event_handler will be called.

Define your own events like this:

class MyEvent(Event):
     topic = "event-topic"
     foo: int
     bar: int

eventipy uses pydantic, so there is automatic type checking!

Tests

Use the package manager pip to install eventipy

pytest tests/unit

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

To bump the version we use bumpversion to handle versions. Actions:

Bug fixes:

$ bumpversion patch # from v1.0.0 -> v1.0.1

New features:

$ bumpversion minor # from v1.0.0 -> v1.1.0

Breaking changes:

$ bumpversion major # from v1.0.0 -> v2.0.0

These commands will create a commit, if you want to avoid this please add the --no-commit flag.

License

We use the MIT license, see LICENSE.md for details