https://github.com/adamcharnock/lightbus

RPC & event framework for Python
https://github.com/adamcharnock/lightbus

bus messaging python queue redis

Last synced: 2 days ago
JSON representation

RPC & event framework for Python

• Host: GitHub
• URL: https://github.com/adamcharnock/lightbus
• Owner: adamcharnock
• License: apache-2.0
• Created: 2017-06-17T10:39:23.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-24T20:51:28.000Z (10 months ago)
• Last Synced: 2024-10-11T11:22:28.868Z (3 months ago)
• Topics: bus, messaging, python, queue, redis
• Language: Python
• Homepage: https://lightbus.org
• Size: 10.2 MB
• Stars: 199
• Watchers: 11
• Forks: 22
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: docs/CODE_OF_CONDUCT.md
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
# What is Lightbus?

[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/f5e5fd4eeb57462b80e2a99e957b7baa)](https://app.codacy.com/gh/adamcharnock/lightbus/dashboard)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](https://lightbus.org/reference/code-of-conduct/)

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**

**[Adam Charnock](https://adamcharnock.com) is available for freelance/contract work.**

## 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:

``` python3

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:

``` python3

import lightbus

bus = lightbus.create()

bus.auth.check_password(

    user='admin',

    password='secret'

)

# Returns true

```

You can also listen for events:

``` python3

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.**