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](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.

New in 0.4.5

  • Created 1 requirements file under examples/chatserver/requirements.txt.

  • Renamed chatclient.py to test_chatclient.py - for django-nose testrunner.

  • Migrated example project to django 1.7.

  • Edited docs/testing.rst to show new changes for using example project.

  • Added support for Python 3.3 and 3.4.

  • Added support for Django-1.8

  • Removes the check for middleware by name.

Features

  • 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](http://www.gevent.org/), 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 Socket.io/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 (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.

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-hypernode.com/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-0.4.6.tar.gz (18.1 kB view details)

Uploaded Source

File details

Details for the file django-websocket-redis-0.4.6.tar.gz.

File metadata

File hashes

Hashes for django-websocket-redis-0.4.6.tar.gz
Algorithm Hash digest
SHA256 a3bed97ba643947938fb715b20d6096322161021504d7bbeeebe32650ab0952c
MD5 0c76c5b9d7f2e93726d17a63fc856adb
BLAKE2b-256 d975c5de70d936b961096d7e819c577e44c45d119c6dc3461b2f282a994cb2d2

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