Welcome to Relé’s documentation!¶
Release v1.13.0. (Installation)
Relé makes integration with Google PubSub easier and is ready to integrate seamlessly into any Django project.
The Publish-Subscribe pattern and specifically the Google Cloud Pub/Sub library are very powerful tools but you can easily cut your fingers on it. Relé makes integration seamless by providing Publisher, Subscriber and Worker classes.
Features¶
Out of the box, Relé includes the following features:
Powerful Publishing API
Highly Scalable Worker
Intuitive Subscription Management
Easily Extensible Middleware
Ready to go Django/Flask integration
CLI
And much more…
What It Looks Like¶
# Subscribe to the Pub/Sub topic
from rele import sub
@sub(topic='photo-uploaded')
def photo_uploaded(data, **kwargs):
print(f"Customer {data['customer_id']} has uploaded an image")
# Publish to the topic
import rele
rele.publish(topic='photo-uploaded', data={'customer_id': 123})
Install¶
Relé supports Python 3.6+ and installing via pip
$ pip install rele
or with Django integration
$ pip install rele[django,flask]
User Guides¶
Configuration¶
Here you can see the full list of the settings options for your deployment of Relé.
API Docs¶
This is the part of documentation that details the inner workings of Relé. If you are looking for information on a specific function, class or method, this part of the documentation is for you.
Changelog¶
Here you can see the full list of changes between each Relé release.
