README.md

What is Lightbus?

Lightbus allows your backend processes to communicate, run background tasks, and expose internal APIs.

Lightbus uses Redis as its underlying transport, although support for other platforms may eventually be added.

Lightbus requires Python 3.9 or above.

Full documentation can be found at https://lightbus.org

Designed for ease of use

Lightbus is designed with developers in mind. The syntax aims to be intuitive and familiar, and common problems are caught with clear and helpful error messages.

For example, a naïve authentication API:

class AuthApi(Api):
    user_registered = Event(parameters=('username', 'email'))

    class Meta:
        name = 'auth'

    def check_password(self, user, password):
        return (
            user == 'admin'
            and password == 'secret'
        )

This can be called as follows:

import lightbus

bus = lightbus.create()

bus.auth.check_password(
    user='admin',
    password='secret'
)
# Returns true

You can also listen for events:

import lightbus

bus = lightbus.create()

def send_signup_email(event_message,
                      username, email):
    send_mail(email,
        subject=f'Welcome {username}'
    )

@bus.client.on_start()
def bus_start(client):
    bus.auth.user_registered.listen(
        send_signup_email
    )

To get started checkout the documentation at https://lightbus.org.