djangorestframework-reactive

============================== Django REST Framework Reactive

|build| |docs| |pypi_version| |pypi_pyversions| |pypi_downloads| |code_style|

.. |build| image:: https://travis-ci.org/genialis/django-rest-framework-reactive.svg?branch=master :target: https://travis-ci.org/genialis/django-rest-framework-reactive :alt: Build Status

.. |docs| image:: https://readthedocs.org/projects/djangorestframework-reactive/badge/?version=latest :target: http://djangorestframework-reactive.readthedocs.io/ :alt: Documentation Status

.. |pypi_version| image:: https://img.shields.io/pypi/v/djangorestframework-reactive.svg :target: https://pypi.org/project/djangorestframework-reactive :alt: Version on PyPI

.. |pypi_pyversions| image:: https://img.shields.io/pypi/pyversions/djangorestframework-reactive.svg :target: https://pypi.org/project/djangorestframework-reactive :alt: Supported Python versions

.. |pypi_downloads| image:: https://pepy.tech/badge/djangorestframework-reactive :target: https://pepy.tech/project/djangorestframework-reactive :alt: Number of downloads from PyPI

.. |code_style| image:: https://img.shields.io/badge/code%20style-black-black.svg :target: https://black.readthedocs.io/ :alt: Code style: black

This package enables regular Django REST Framework views to become reactive, that is so that client-side applications may get notified of changes to the underlying data as soon as they happen, without the need to poll the API again. While the initial request is done as a regular HTTP request, all the update notifications come through WebSockets.

Install

Prerequisites

The reactive extensions for Django REST Framework require the use of Django Channels_ for push notifications via WebSockets.

.. _Django Channels: https://channels.readthedocs.io

From PyPI

.. code::

pip install djangorestframework-reactive

From source

.. code::

pip install https://github.com/genialis/django-rest-framework-reactive/archive/.tar.gz

where <git-tree-ish> can represent any commit SHA, branch name, tag name, etc. in DRF Reactive's GitHub repository_. For example, to install the latest version from the master branch, use:

.. code::

pip install https://github.com/genialis/django-rest-framework-reactive/archive/master.tar.gz

.. _DRF Reactive's GitHub repository: https://github.com/genialis/django-rest-framework-reactive/

Configure

First, add rest_framework_reactive to INSTALLED_APPS.

Configure your Django Channels routing.py to include the required paths:

.. code::

from django.urls import path

from channels.routing import ChannelNameRouter, ProtocolTypeRouter, URLRouter

from rest_framework_reactive.consumers import ClientConsumer, MainConsumer, WorkerConsumer
from rest_framework_reactive.protocol import CHANNEL_MAIN, CHANNEL_WORKER

application = ProtocolTypeRouter({
    # Client-facing consumers.
    'websocket': URLRouter([
        # To change the prefix, you can import ClientConsumer in your custom
        # Channels routing definitions instead of using these defaults.
        path('ws/<slug:subscriber_id>', ClientConsumer),
    ]),

    # Background worker consumers.
    'channel': ChannelNameRouter({
        CHANNEL_MAIN: MainConsumer,
        CHANNEL_WORKER: WorkerConsumer,
    })
})

Also, urls.py need to be updated to include some additional paths:

.. code::

urlpatterns = [ # ... url(r'^api/queryobserver/', include('rest_framework_reactive.api_urls')), # ... ]

Run

In addition to running a Django application server instance, you need to also run a separate observer worker process (or multiple of them). You may start it by running:

.. code::

python manage.py runworker rest_framework_reactive.main rest_framework_reactive.worker