This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

A framework for implementing real-time APIs in Django web applications

Project Description

Django-RT

Current version:
 0.3.1 pre-alpha

Django-RT is a framework for implementing real-time APIs in Django web applications. This framework follows the traditional publish/subscribe methodology, using Redis as the pub/sub provider.

Django-RT consists of two major components:

  • Application API: This provides the necessary functionality to allow you to easily add a real-time API to your Django application.
  • “Courier” HTTP server: A lightweight, asynchronous server designed solely to deliver real-time messages to web clients.

WARNING: Django-RT is currently in pre-alpha stages of development, and is not ready for public consumption. Expect major API changes and, potentially, security risks in pre-alpha releases. Use in production at your own risk!


Uses

  • Web chat
  • User notifications
  • Real-time charts (server monitoring, stock tickers, etc)

Features

  • Simple to integrate with any existing Django project
  • Trivial client-side JavaScript implementation with SSE (Server-Sent Events); no third-party libraries needed with modern browsers.
  • Asynchronous server design to handle many long-running client connections from a single thread
  • Decoupled server architecture allows for the use of blocking code (database access, cache access, etc) in callbacks, without compromising the operation of the delivery server
  • Deployable on existing Heroku apps, using uWSGI

Requirements

  • Django >= 1.7
  • Python >= 3.4 (2.7+ support planned)
  • A Redis server (TODO: minimum Redis version)

Deployment

Courier server

There are currently 2 production servers to choose from:

  • aiohttp/asyncio (recommended): Python >= 3.4
  • gevent WSGI: Python >= 3.4

Protocols

SSE (Server-Sent Events) is the only delivery protocol currently supported.

Limitations

  • Only one-way delivery is currently supported (server to client). Messages originating from the client should use a conventional AJAX request. This should be sufficient for the majority of applications.
  • Real-time functionality can only be added to Django Class-Based Views (CBVs). Older function-style views are not supported.

How it works

TODO

Release History

Release History

This version
History Node

0.3.1

History Node

0.3

History Node

0.2

History Node

0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django-rt-0.3.1.tar.gz (13.6 kB) Copy SHA256 Checksum SHA256 Source May 29, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting