Skip to main content

django-mease: Websocket integration made easy for Django

Project description

Work in progress.

Websocket integration made easy for Django using Tornado, Redis PUB/SUB and easy to use callback registry mechanism.

See a full working example here

RTD INCOMING SHORTLY

Installation

Dependencies (Debian & Ubuntu)

Mease comes with Redis PUB/SUB backend by default. If you want to use it, install these dependencies :

sudo apt-get install redis-server python-dev
pip install redis

Install django-mease

pip install django-mease

Add mease to your INSTALLED_APPS

INSTALLED_APPS = (
  # List of your installed apps
  'djmease',
)

Usage

Start websocket server

python manage.py run_websocket_server

Register callbacks

Create mease_registry.py files to register your callbacks (the file must be located in an installed app):

from djmease import mease

@mease.opener
def open_websocket(client, clients_list):
    client.storage["name"] = "mymane"
    for c in clients_list:
        c.send("Someone joined")

@mease.closer
def close_websocket(client, clients_list):
    for c in clients_list:
        c.send("{name} left".format(name=client.storage["name"]))

@mease.receiver
def receive_websocket_message(client, clients_list, message):
    for c in clients_list:
        c.send(message)

@mease.sender(routing=['websocket'])
def send_websocket_message(channel, clients_list, myobj):
    for c in clients_list:
        c.send(myobj.myattr)

Publish

Use mease.publish to publish from anywhere in your code :

from djmease import mease

mease.publish('websocket', "Hello world !")

This will call all sender functions registered on the ‘websocket’ routing.

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

django-mease-0.2.0.tar.gz (3.9 kB view hashes)

Uploaded Source

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