https://github.com/jrief/django-websocket-redis
Websockets for Django applications using Redis as message queue
https://github.com/jrief/django-websocket-redis
Last synced: 7 months ago
JSON representation
Websockets for Django applications using Redis as message queue
- Host: GitHub
- URL: https://github.com/jrief/django-websocket-redis
- Owner: jrief
- License: mit
- Created: 2013-12-13T07:06:19.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2025-03-03T10:20:22.000Z (9 months ago)
- Last Synced: 2025-04-14T04:58:24.881Z (8 months ago)
- Language: Python
- Homepage: http://django-websocket-redis.awesto.com/
- Size: 647 KB
- Stars: 897
- Watchers: 35
- Forks: 221
- Open Issues: 101
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-django - django-websocket-redis - Websockets for Django applications using Redis as message queue. (Other)
- awesome-django - django-websocket-redis - Websockets for Django applications using Redis as message queue. (Other)
- awesome-django-cn - django-websocket-redis, star:611 - 为 Django 应用实现的 Websockets，使用 Redis 作为消息队列。 (其它)
README
django-websocket-redis
======================
Project home: https://github.com/jrief/django-websocket-redis
Detailed documentation on [ReadTheDocs](http://django-websocket-redis.readthedocs.org/en/latest/).
Online demo: http://django-websocket-redis.awesto.com/
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](http://redis.io/) datastore and in a production environment, it is
intended to work under [uWSGI](http://projects.unbit.it/uwsgi/) and behind [NGiNX](http://nginx.com/)
or [Apache](http://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.html) version 2.4.5 or later.
Features
--------
* Largely scalable for Django applications with many hundreds of open websocket connections.
* Runs a separate Django main loop in a cooperative concurrency model using [gevent](http://www.gevent.org/),
thus only one thread/process is required to control *all* open websockets simultaneously.
* Full control over this separate 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
Socket.io/Node.js.
* Normal Django requests communicate with this separate main loop through **Redis** which, by the way is a good
replacement for memcached.
* Optionally persisting 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 (BDFL of uWSGI) article about
[Offloading Websockets and Server-Sent Events AKA “Combine them with Django safely”](http://uwsgi-docs.readthedocs.org/en/latest/articles/OffloadingWebsocketsAndSSE.html).
Please also consider, that whichever alternative technology you use, you always need a message queue,
so that the Django application can “talk” to the browser. This is because the only link between the browser and
the server is through the Websocket and thus, by definition a long living connection. For scalability reasons you
can't start a Django server thread for each of these connections.
Release History
---------------
Refer to [changelog.rst](docs/changelog.rst)
Build status
------------
[](https://travis-ci.org/jrief/django-websocket-redis)
[](https://pypi.python.org/pypi/django-websocket-redis/)
Questions
---------
Please use the issue tracker to ask questions.
License
-------
Copyright © 2015 Jacob Rief.
MIT licensed.