Metadata-Version: 1.1
Name: django-websocket-redis
Version: 0.4.5
Summary: Websocket support for Django using Redis as datastore
Home-page: https://github.com/jrief/django-websocket-redis
Author: Jacob Rief
Author-email: jacob.rief@gmail.com
License: MIT
Description: 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://websocket.aws.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| |Downloads|
        
        Questions
        ---------
        
        Please use the issue tracker to ask questions.
        
        License
        -------
        
        Copyright © 2015 Jacob Rief.
        
        MIT licensed.
        
        .. |Build Status| image:: https://travis-ci.org/jrief/django-websocket-redis.png?branch=master
           :target: https://travis-ci.org/jrief/django-websocket-redis
        .. |Downloads| image:: http://img.shields.io/pypi/dm/django-websocket-redis.svg?style=flat-square
           :target: https://pypi.python.org/pypi/django-websocket-redis/
        
Keywords: django,websocket,redis
Platform: OS Independent
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.5
Classifier: Framework :: Django :: 1.6
Classifier: Framework :: Django :: 1.7
Classifier: Framework :: Django :: 1.8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
