Django REST Live documentation

django-rest-live adds real-time subscriptions over websockets to Django REST Framework views by leveraging websocket support provided by Django Channels.

Inspiration and Goals

django-rest-live took initial inspiration from this article by Kit La Touche.

The goal of this project is to be as close as possible to a drop-in realtime solution for projects already using Django REST Framework.

Differently from projects like djangochannelsrestframework, django-rest-live does not aim to supplant REST Framework for performing CRUD actions through a REST API. Instead, it is designed to be used in conjunction with HTTP REST endpoints. Clients should still use normal REST framework endpoints generated by ViewSets and other API views to get initial data to populate a page, as well as any write-driven behavior (POST, PATCH, PUT, DELETE). django-rest-live gets rid of the need for periodic polling GET requests to for resource updates after page load.