Skip to main content

Websocket support for Django using Redis as datastore

Project description

Project home: https://github.com/jrief/django-websocket-redis

Detailed documentation on ReadTheDocs.

Websockets for Django using Redis as message queue

This module implements websockets on top of Django without requiring any additional framework. For messaging it uses the Redis datastore and in a production environment, it is intended to work under uWSGI and behind NGiNX.

New in 0.4.0

  • Messages can be sent to users being member of one or more Django groups.

  • Simplified the usage of RedisPublisher and RedisSubscriber to make the API more consistent.

  • Added the possibility to receive heartbeats.

  • Added reusable JavaScript code for the client.

  • Added a context processor to inject some settings from ws4redis into templates.

Features

  • Largely scalable for Django applications with hundreds of open websocket connections.

  • Runs in a cooperative concurrency model using gevent, thus only one thread/process is simultaneously required to control all open websockets.

  • Full control over the main loop during development, so Django can be started as usual with ./manage.py runserver.

  • No dependency to any other asynchronous event driven framework, such as Tornado, Twisted or Node.js.

  • Optionally persiting messages, allowing server reboots and client reconnections.

  • The only additional requirement is a running instance of Redis, which by the way is a good replacement for memcached.

If unsure, if this proposed architecture is the correct approach on how to integrate websockets with Django, then please read Roberto De Ioris article about Offloading Websockets and Server-Sent Events AKA “Combine them with Django safely”.

Build status

Build Status

Questions

Please use the issue tracker to ask questions.

License

Copyright © 2014 Jacob Rief. Licensed under the MIT license.

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-websocket-redis-0.4.0rc1.tar.gz (16.2 kB view details)

Uploaded Source

File details

Details for the file django-websocket-redis-0.4.0rc1.tar.gz.

File metadata

File hashes

Hashes for django-websocket-redis-0.4.0rc1.tar.gz
Algorithm Hash digest
SHA256 92047c5b335aadd68942696bc3196dc70a5a5bc000fe4461e4356e613fb9698e
MD5 e81a82df8f22a61d1c6dc0928bad1d3f
BLAKE2b-256 66fedcf1903bcdd2627cf072ae0a459c81637497ea7e6dce4509c51f686bac7c

See more details on using hashes here.

Provenance

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