Metadata-Version: 2.0
Name: django-omnibus
Version: 0.2.0
Summary: Django/JavaScript WebSocket Connections
Home-page: https://github.com/moccu/django-omnibus/
Author: Moccu GmbH & Co. KG
Author-email: info@moccu.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Framework :: Django
Requires-Dist: Django (>=1.4)
Requires-Dist: pyzmq (==14.1.1)
Requires-Dist: tornado (==3.1.1)
Requires-Dist: sockjs-tornado (>=1.0.0)
Provides-Extra: docs
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest (>=2.5.2); extra == 'tests'
Requires-Dist: pytest-cov (>=1.6); extra == 'tests'
Requires-Dist: pytest-flakes (>=0.2); extra == 'tests'
Requires-Dist: pytest-pep8 (>=1.0.5); extra == 'tests'
Requires-Dist: pytest-django (>=2.6); extra == 'tests'
Requires-Dist: mock (==1.0.1); extra == 'tests'
Requires-Dist: pep8 (==1.4.6); extra == 'tests'
Provides-Extra: dev
Requires-Dist: tox; extra == 'dev'

# django-omnibus

Django/JavaScript WebSocket Connections.

[![Coverage Status](https://coveralls.io/repos/moccu/django-omnibus/badge.png)](https://coveralls.io/r/moccu/django-omnibus)
[![Travis Status](https://travis-ci.org/moccu/django-omnibus.png?branch=master)](https://travis-ci.org/moccu/django-omnibus)

## What is django-omnibus

*django-omnibus* is a Django library which helps to create websocket-based
connections between a browser and a server to deliver messages.

Some use cases could be:

* Chat systems
* Realtime stream updates
* Inter-browser communication
* file transfers
* and so on..

*django-omnibus* is quite extensible. The connection handler, the
Tornado web application and the authenticator can be replaced by just changing
a setting.

For browser compatibility *django-omnibus* also supports
[SockJS](https://github.com/sockjs/sockjs-client) (which provides fallbacks for
older browsers).

On the client side, django-omnibus provides a library which handles
the connection, authentication and channel subscription (multiple channels can
be subscribed using one connection).

## Installation & Documentation

All documentation is in the "docs/source" directory and online at
[Read the Docs](https://django-omnibus.readthedocs.org/).

## License
*django-omnibus* is licenced under the [BSD License](LICENSE.md).


