Skip to main content

Websockets support for Django using Redis as datastore

Project description

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.

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-plus-0.6.0.2.tar.gz (20.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file django-websocket-redis-plus-0.6.0.2.tar.gz.

File metadata

  • Download URL: django-websocket-redis-plus-0.6.0.2.tar.gz
  • Upload date:
  • Size: 20.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for django-websocket-redis-plus-0.6.0.2.tar.gz
Algorithm Hash digest
SHA256 a12f9aefe4e2e5c4b568c7f46bb64c84ab94bd0bda146bb4f2c218c80d5c467a
MD5 f7adcbb2ed64a67eb137b5a7265df77f
BLAKE2b-256 8036735bb4b3d49c474934385cb612675203a880dd9a8363c59cb53a047bb138

See more details on using hashes here.

File details

Details for the file django_websocket_redis_plus-0.6.0.2-py3-none-any.whl.

File metadata

  • Download URL: django_websocket_redis_plus-0.6.0.2-py3-none-any.whl
  • Upload date:
  • Size: 24.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for django_websocket_redis_plus-0.6.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 74fc3f26b275124a92618878bf9bd9464a138b6e3acb37fe1556e7582360119a
MD5 778cb3b4becf14593abefc5b3567ab89
BLAKE2b-256 da8bd49dde5511f192c98ddfb7776f02a9811c9a35f7cfca79379dc1290db2eb

See more details on using hashes here.

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