Welcome to djangochannelsrestframework’s documentation!

Introduction

Django Channels Rest Framework

Django Channels Rest Framework provides a DRF like interface for building channels-v4 websocket consumers.

This project can be used alongside HyperMediaChannels and ChannelsMultiplexer to create a Hyper Media Style API over websockets. However Django Channels Rest Framework is also a free standing framework with the goal of providing an API that is familiar to DRF users.

theY4Kman has developed a useful Javascript client library dcrf-client to use with DCRF.

Installation

pip install djangochannelsrestframework

Thanks to

DCRF is based of a fork of Channels Api and of course inspired by Django Rest Framework.

Indices and tables