django-omnibus is a Django library which helps to create websocket-based connections between a browser and a server to deliver messages.
JavaScript Python HTML Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

django-omnibus

Django/JavaScript WebSocket Connections.

Coverage Status Travis Status

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

License

django-omnibus is licenced under the BSD License.