Django Channels v2

Author: SmileyChris

README.md

@@ -132,7 +132,6 @@ You can see a full example here: https://github.com/graphql-python/graphql-ws/tr
 
 ### Django Channels
 
-
 First `pip install channels` and it to your django apps
 
 Then add the following to your settings.py
@@ -202,4 +201,82 @@ from graphql_ws.django_channels import GraphQLSubscriptionConsumer
 channel_routing = [
     route_class(GraphQLSubscriptionConsumer, path=r"^/subscriptions"),
 ]
-```
+```
+
+### Django Channels 2
+
+Set up with Django Channels just takes three steps:
+
+1. Install the apps
+2. Set up schema
+3. Set up channels Router
+
+
+First `pip install channels` and it to your `INSTALLED_APPS`. If you want
+graphiQL, install `graphql_ws.django` app before `graphene_django` to serve a
+graphiql template that will work with websockets:
+
+```python
+INSTALLED_APPS = [
+    "channels",
+    "graphql_ws.django",
+    "graphene_django",
+    # ...
+]
+```
+
+
+Next, set up your graphql schema:
+
+```python
+import graphene
+from rx import Observable
+
+
+class Query(graphene.ObjectType):
+    hello = graphene.String()
+
+    def resolve_hello(self, info, **kwargs):
+        return "world"
+
+
+class Subscription(graphene.ObjectType):
+
+    count_seconds = graphene.Int(up_to=graphene.Int())
+
+    def resolve_count_seconds(root, info, up_to=5):
+        return (
+            Observable.interval(1000)
+            .map(lambda i: "{0}".format(i))
+            .take_while(lambda i: int(i) <= up_to)
+        )
+
+
+schema = graphene.Schema(query=Query, subscription=Subscription)
+```
+
+...and point to your schema in Django settings
+```python
+GRAPHENE = {
+    'SCHEMA': 'yourproject.schema'
+}
+```
+
+
+Finally, configure channels routing (it'll be served from `/subscriptions`):
+
+```python
+from channels.routing import ProtocolTypeRouter, URLRouter
+from graphql_ws.django.graphql_channels import (
+    websocket_urlpatterns as graphql_urlpatterns
+)
+
+application = ProtocolTypeRouter({"websocket": URLRouter(graphql_urlpatterns)})
+```
+
+...and point to the application in Django settings
+```python
+ASGI_APPLICATION = 'yourproject.schema'
+```
+
+Run `./manage.py runserver` and go to `http://localhost:8000/graphql` to test!

README.rst

@@ -5,7 +5,9 @@ Websocket server for GraphQL subscriptions.
 
 Currently supports: \*
 `aiohttp <https://github.com/graphql-python/graphql-ws#aiohttp>`__ \*
-`Gevent <https://github.com/graphql-python/graphql-ws#gevent>`__
+`Gevent <https://github.com/graphql-python/graphql-ws#gevent>`__ \*
+Sanic (uses `websockets <https://github.com/aaugustin/websockets/>`__
+library)
 
 Installation instructions
 =========================
@@ -44,6 +46,29 @@ For setting up, just plug into your aiohttp server.
 
     web.run_app(app, port=8000)
 
+Sanic
+~~~~~
+
+Works with any framework that uses the websockets library for it's
+websocket implementation. For this example, plug in your Sanic server.
+
+.. code:: python
+
+    from graphql_ws.websockets_lib import WsLibSubscriptionServer
+
+
+    app = Sanic(__name__)
+
+    subscription_server = WsLibSubscriptionServer(schema)
+
+    @app.websocket('/subscriptions', subprotocols=['graphql-ws'])
+    async def subscriptions(request, ws):
+        await subscription_server.handle(ws)
+        return ws
+
+
+    app.run(host="0.0.0.0", port=8000)
+
 And then, plug into a subscribable schema:
 
 .. code:: python
@@ -111,3 +136,156 @@ And then, plug into a subscribable schema:
 
 You can see a full example here:
 https://github.com/graphql-python/graphql-ws/tree/master/examples/flask\_gevent
+
+Django Channels
+~~~~~~~~~~~~~~~
+
+First ``pip install channels`` and it to your django apps
+
+Then add the following to your settings.py
+
+.. code:: python
+
+        CHANNELS_WS_PROTOCOLS = ["graphql-ws", ]
+        CHANNEL_LAYERS = {
+            "default": {
+                "BACKEND": "asgiref.inmemory.ChannelLayer",
+                "ROUTING": "django_subscriptions.urls.channel_routing",
+            },
+
+        }
+
+Setup your graphql schema
+
+.. code:: python
+
+    import graphene
+    from rx import Observable
+
+
+    class Query(graphene.ObjectType):
+        hello = graphene.String()
+
+        def resolve_hello(self, info, **kwargs):
+            return 'world'
+
+    class Subscription(graphene.ObjectType):
+
+        count_seconds = graphene.Int(up_to=graphene.Int())
+
+
+        def resolve_count_seconds(
+            root, 
+            info, 
+            up_to=5
+        ):
+            return Observable.interval(1000)\
+                             .map(lambda i: "{0}".format(i))\
+                             .take_while(lambda i: int(i) <= up_to)
+
+
+
+    schema = graphene.Schema(
+        query=Query,
+        subscription=Subscription
+    )
+
+Setup your schema in settings.py
+
+.. code:: python
+
+    GRAPHENE = {
+        'SCHEMA': 'path.to.schema'
+    }
+
+and finally add the channel routes
+
+.. code:: python
+
+    from channels.routing import route_class
+    from graphql_ws.django_channels import GraphQLSubscriptionConsumer
+
+    channel_routing = [
+        route_class(GraphQLSubscriptionConsumer, path=r"^/subscriptions"),
+    ]
+
+Django Channels 2
+~~~~~~~~~~~~~~~~~
+
+Set up with Django Channels just takes three steps:
+
+1. Install the apps
+2. Set up schema
+3. Set up channels Router
+
+First ``pip install channels`` and it to your ``INSTALLED_APPS``. If you
+want graphiQL, install ``graphql_ws.django`` app before
+``graphene_django`` to serve a graphiql template that will work with
+websockets:
+
+.. code:: python
+
+    INSTALLED_APPS = [
+        "channels",
+        "graphql_ws.django",
+        "graphene_django",
+        # ...
+    ]
+
+Next, set up your graphql schema:
+
+.. code:: python
+
+    import graphene
+    from rx import Observable
+
+
+    class Query(graphene.ObjectType):
+        hello = graphene.String()
+
+        def resolve_hello(self, info, **kwargs):
+            return "world"
+
+
+    class Subscription(graphene.ObjectType):
+
+        count_seconds = graphene.Int(up_to=graphene.Int())
+
+        def resolve_count_seconds(root, info, up_to=5):
+            return (
+                Observable.interval(1000)
+                .map(lambda i: "{0}".format(i))
+                .take_while(lambda i: int(i) <= up_to)
+            )
+
+
+    schema = graphene.Schema(query=Query, subscription=Subscription)
+
+...and point to your schema in Django settings
+
+.. code:: python
+
+    GRAPHENE = {
+        'SCHEMA': 'yourproject.schema'
+    }
+
+Finally, configure channels routing (it'll be served from
+``/subscriptions``):
+
+.. code:: python
+
+    from channels.routing import ProtocolTypeRouter, URLRouter
+    from graphql_ws.django.graphql_channels import (
+        websocket_urlpatterns as graphql_urlpatterns
+    )
+
+    application = ProtocolTypeRouter({"websocket": URLRouter(graphql_urlpatterns)})
+
+...and point to the application in Django settings
+
+.. code:: python
+
+    ASGI_APPLICATION = 'yourproject.schema'
+
+Run ``./manage.py runserver`` and go to
+``http://localhost:8000/graphql`` to test!

examples/django_channels2/Pipfile

@@ -0,0 +1,14 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[dev-packages]
+
+[packages]
+graphql-ws = {path = "./../..", editable = true}
+channels = "*"
+graphene-django = "*"
+
+[requires]
+python_version = "3.6"