Project home: https://github.com/jrief/django-websocket-redis
Detailed documentation on ReadTheDocs.
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.
- Message echoing can be switched “on” and “off” according to the user needs. Before it was “on” by default.
- Many changes to become compatible with Python3; there are still minor issues to solve.
- The message string to be passed and stored to and from the websocket hase been converted into
a class
RedisMessagefor type saftey.
- Largely scalable for Django applications with many hundreds of open websocket connections.
- Runs a seperate Django main loop in a cooperative concurrency model using gevent, thus only one thread/process is required to control all open websockets simultaneously.
- Full control over this seperate 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.
- Normal Django requests communicate with this seperate main loop through Redis, which by the way is a good replacement for memcached.
- Optionally persiting messages, allowing server reboots and client reconnections.
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”.
Please use the issue tracker to ask questions.
Copyright © 2014 Jacob Rief.
MIT licensed.