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.

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 datastore and in a production environment, it is intended to work under uWSGI and behind NGiNX.

Features

  • Largely scalable for Django applications with hundreds of open websocket connections.

  • Runs in a cooperative concurrency model using gevent, thus only one thread/process is simultaneously required to control all open websockets.

  • Full control over the 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.

  • Optionally persiting messages, allowing server reboots and client reconnections.

  • The only additional requirement is a running instance of Redis, which by the way is a good replacement for memcached.

Build status

Build Status

Questions

Please use the issue tracker to ask questions.

License

Copyright (c) 2013 Jacob Rief
Licensed under the MIT license.

Release History

  • 0.2.2

  • Moved mokey patching for Redis socket into the runner. This sometimes caused errors when running in development mode.

  • Added timeout to select call. This caused IOerrors when running under uWSGI and the websocket was idle.

  • 0.2.1 - Reverted issue #1 and dropped compatibility with Django-1.4 since the response status must use force_str.

  • 0.2.0 - Major API change

  • Use WS4REDIS_… in Django settings

  • Persist messages, allowing server reboots and reconnecting the client

  • Share the file descriptor for Redis for all open connections

  • Allow to override the subscribe/publish engine

  • 0.1.2 - fixed: Can use publish to websocket without subscribing

  • 0.1.1 - instead of CLI monkey patching, explicitly patch the redis.connection.socket using gevent.socket

  • 0.1.0 - initial revision

Bitdeli Badge

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.2.3.tar.gz (12.6 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for django-websocket-redis-0.2.3.tar.gz
Algorithm Hash digest
SHA256 59b66d4fe9559f08e0681c8cc00933f5ae5ac75572e5525321c461d0a419a3cc
MD5 a208f61368291647551712a364a6a4f2
BLAKE2b-256 3a162c6854dcde0cc5826d08c142be0833b94f4c859915b1f35f8145cc54d2f1

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