Skip to main content

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

[![Build Status](https://travis-ci.org/jrief/django-websocket-redis.png?branch=master)](https://travis-ci.org/jrief/django-websocket-redis) [![Downloads](http://img.shields.io/pypi/dm/django-websocket-redis.svg?style=flat-square)](https://pypi.python.org/pypi/django-websocket-redis/)

Questions

Please use the issue tracker to ask questions.

License

Copyright © 2015 Jacob Rief.

MIT licensed.

Release files for django-websocket-redis-up 0.6.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for django-websocket-redis-up 0.6.4
File Interpreter ABI Platform
django_websocket_redis_up-0.6.4-py2.py3-none-any.whl Python 3, Python 2 none any Details

Release files / django_websocket_redis_up-0.6.4-py2.py3-none-any.whl

Download URL django_websocket_redis_up-0.6.4-py2.py3-none-any.whl
Size 24.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
a7ab5e00e3a45ac238588ac1c22b11054f77e3ffd967bac07cf3d114b8ec9203
BLAKE2b-256 checksum
How to use checksums
616961df331986e0379f33a8bb72978595c10e44d4945a6721ff9dfd57487363
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.10.4

Release history Release notifications | RSS feed

This release

0.6.4 This release

1 release file

0.6.3

1 release file

0.6.2

1 release file

0.6.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page