Skip to main content

Event manager library

Project description

Build Maintainability Test Coverage

OnAny is a simple yet powerful event manager library, where you can declare listeners and dispatch as much events as needed to them.

How To

To listen and dispatch events is very simple:

from onany import dispatch, listener

@listener("event.name")
def on_event_name(*args, **kwargs):
    print("I've been called with {} and {}".format(
        args,
        kwargs
    ))

>>> dispatch(
    "event.name",
    "first_param",
    "second_param",
    "third_param",
    first="param",
    second="param",
    third="param")

Should I wait all callbacks to end ?

Nope. You can “threadily” dispatch your events so they don’t need to be waited for the main process.

from onany import disthread, listener

@listener("event.name")
def on_event_name():
    print("I'm gonna be executed on another thread")

>>> disthread("event.name")

Webhook listener

It’s possible declare webhook rules to be dispatched as an inside event. This webhook events can be a powerful tool for communicating to third-party clients that an event is ended.

Listener rules:

  • route
    • type: str

    • description: API route

    • required

  • callback
    • type: callable/function

    • description: Receives request response object if needed

When dispatch or disthread is called is possible define some attributes to be sent in the external API call.

Attributes:

  • data
    • type: dict

    • description: JSON body

  • headers
    • type: dict

    • description: Dictionary declaring headers to be sent

Example:

from onany import dispatch, listener

def event_name_webhook_response(response):
    if response.status_code == 200:
        print("My hook listener worked")

listener("event.name", {
    "route": "https://my.api/hooks",
    "callback": event_name_webhook_response
})

>>> dispatch("event.name", data={
    "some": "payload",
    "I": "wanna",
    "send": "to",
    "hooked": "api"
})

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

onany-0.2.0.tar.gz (3.6 kB view hashes)

Uploaded Source

Built Distribution

onany-0.2.0-py3-none-any.whl (4.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page