graphene-subscriptions | play GraphQL subscription implementation for Graphene | GraphQL library

Add graphene_subscriptions to INSTALLED_APPS:.
Install graphene-subscriptions $ pip install graphene-subscriptions
Add graphene_subscriptions to INSTALLED_APPS: # your_project/settings.py INSTALLED_APPS = [ # ... 'graphene_subscriptions' ]
Add Django Channels to your project (see: Django Channels installation docs) and set up Channel Layers. If you don't want to set up a Redis instance in your dev environment yet, you can use the in-memory Channel Layer: # your_project/settings.py CHANNEL_LAYERS = { "default": { "BACKEND": "channels.layers.InMemoryChannelLayer" } }
Add GraphqlSubscriptionConsumer to your routing.py file. # your_project/routing.py from channels.routing import ProtocolTypeRouter, URLRouter from django.urls import path from graphene_subscriptions.consumers import GraphqlSubscriptionConsumer application = ProtocolTypeRouter({ "websocket": URLRouter([ path('graphql/', GraphqlSubscriptionConsumer) ]), })
Connect signals for any models you want to create subscriptions for # your_app/signals.py from django.db.models.signals import post_save, post_delete from graphene_subscriptions.signals import post_save_subscription, post_delete_subscription from your_app.models import YourModel post_save.connect(post_save_subscription, sender=YourModel, dispatch_uid="your_model_post_save") post_delete.connect(post_delete_subscription, sender=YourModel, dispatch_uid="your_model_post_delete") # your_app/apps.py from django.apps import AppConfig class YourAppConfig(AppConfig): name = 'your_app' def ready(self): import your_app.signals
Define your subscriptions and connect them to your project schema #your_project/schema.py import graphene from your_app.graphql.subscriptions import YourSubscription class Query(graphene.ObjectType): base = graphene.String() class Subscription(YourSubscription): pass schema = graphene.Schema( query=Query, subscription=Subscription )