Update and simplify the channels2 example

Author: SmileyChris

README.md

@@ -208,13 +208,13 @@ channel_routing = [
 Set up with Django Channels just takes three steps:
 
 1. Install the apps
-2. Set up schema
-3. Set up channels Router
+2. Set up your schema
+3. Configure the channels router application
 
 
 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:
+graphiQL, install the `graphql_ws.django` app before `graphene_django` to serve
+a graphiQL template that will work with websockets:
 
 ```python
 INSTALLED_APPS = [
@@ -263,20 +263,14 @@ GRAPHENE = {
 ```
 
 
-Finally, configure channels routing (it'll be served from `/subscriptions`):
+Finally, you can set up channels routing yourself (maybe using
+`graphql_ws.django.routing.websocket_urlpatterns` in your `URLRouter`), or you
+can just use one of the preset channels applications:
 
 ```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'
+ASGI_APPLICATION = 'graphql_ws.django.routing.application'
+# or
+ASGI_APPLICATION = 'graphql_ws.django.routing.auth_application'
 ```
 
 Run `./manage.py runserver` and go to `http://localhost:8000/graphql` to test!

README.rst

@@ -215,12 +215,12 @@ 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
+2. Set up your schema
+3. Configure the channels router application
 
 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
+want graphiQL, install the ``graphql_ws.django`` app before
+``graphene_django`` to serve a graphiQL template that will work with
 websockets:
 
 .. code:: python
@@ -269,23 +269,16 @@ Next, set up your graphql schema:
         'SCHEMA': 'yourproject.schema'
     }
 
-Finally, configure channels routing (it'll be served from
-``/subscriptions``):
+Finally, you can set up channels routing yourself (maybe using
+``graphql_ws.django.routing.websocket_urlpatterns`` in your
+``URLRouter``), or you can just use one of the preset channels
+applications:
 
 .. 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'
+    ASGI_APPLICATION = 'graphql_ws.django.routing.application'
+    # or
+    ASGI_APPLICATION = 'graphql_ws.django.routing.auth_application'
 
 Run ``./manage.py runserver`` and go to
 ``http://localhost:8000/graphql`` to test!

examples/django_channels2/Pipfile

@@ -7,7 +7,7 @@ name = "pypi"
 
 [packages]
 graphql-ws = {path = "./../..", editable = true}
-channels = "*"
+channels = "==2.*"
 graphene-django = "*"
 
 [requires]

examples/django_channels2/Pipfile.lock

@@ -10,7 +10,6 @@ def resolve_hello(self, info, **kwargs):
 
 
 class Subscription(graphene.ObjectType):
-
     count_seconds = graphene.Int(up_to=graphene.Int())
 
     def resolve_count_seconds(root, info, up_to=5):

examples/django_channels2/django_channels2/routing.py

@@ -1,58 +1,11 @@
 """
 Django settings for django_channels2 project.
-
-Generated by 'django-admin startproject' using Django 2.0.7.
-
-For more information on this file, see
-https://docs.djangoproject.com/en/2.0/topics/settings/
-
-For the full list of settings and their values, see
-https://docs.djangoproject.com/en/2.0/ref/settings/
 """
-
-import os
-
-# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
-BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-
-
-# Quick-start development settings - unsuitable for production
-# See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/
-
-# SECURITY WARNING: keep the secret key used in production secret!
 SECRET_KEY = "0%1c709jhmggqhk&=tci06iy+%jedfxpcoai69jd8wjzm+k2f0"
-
-# SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
-ALLOWED_HOSTS = []
 
-
-# Application definition
-
-INSTALLED_APPS = [
-    "channels",
-    "graphql_ws.django",
-    "graphene_django",
-    "django.contrib.admin",
-    "django.contrib.auth",
-    "django.contrib.contenttypes",
-    "django.contrib.sessions",
-    "django.contrib.messages",
-    "django.contrib.staticfiles",
-]
-
-MIDDLEWARE = [
-    "django.middleware.security.SecurityMiddleware",
-    "django.contrib.sessions.middleware.SessionMiddleware",
-    "django.middleware.common.CommonMiddleware",
-    "django.middleware.csrf.CsrfViewMiddleware",
-    "django.contrib.auth.middleware.AuthenticationMiddleware",
-    "django.contrib.messages.middleware.MessageMiddleware",
-    "django.middleware.clickjacking.XFrameOptionsMiddleware",
-]
-
-ROOT_URLCONF = "django_channels2.urls"
+INSTALLED_APPS = ["channels", "graphql_ws.django", "graphene_django"]
 
 TEMPLATES = [
     {
@@ -63,59 +16,14 @@
             "context_processors": [
                 "django.template.context_processors.debug",
                 "django.template.context_processors.request",
-                "django.contrib.auth.context_processors.auth",
-                "django.contrib.messages.context_processors.messages",
             ]
         },
     }
 ]
 
-WSGI_APPLICATION = "django_channels2.wsgi.application"
-ASGI_APPLICATION = "django_channels2.routing.application"
-
-
-# Database
-# https://docs.djangoproject.com/en/2.0/ref/settings/#databases
 
-DATABASES = {
-    "default": {
-        "ENGINE": "django.db.backends.sqlite3",
-        "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
-    }
-}
-
-
-# Password validation
-# https://docs.djangoproject.com/en/2.0/ref/settings/#auth-password-validators
-
-AUTH_PASSWORD_VALIDATORS = [
-    {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
-    },
-    {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
-    {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
-    {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
-]
-
-
-# Internationalization
-# https://docs.djangoproject.com/en/2.0/topics/i18n/
-
-LANGUAGE_CODE = "en-us"
-
-TIME_ZONE = "UTC"
-
-USE_I18N = True
-
-USE_L10N = True
-
-USE_TZ = True
-
-
-# Static files (CSS, JavaScript, Images)
-# https://docs.djangoproject.com/en/2.0/howto/static-files/
-
-STATIC_URL = "/static/"
+ROOT_URLCONF = "django_channels2.urls"
+ASGI_APPLICATION = "graphql_ws.django.routing.application"
 
 
 GRAPHENE = {"MIDDLEWARE": [], "SCHEMA": "django_channels2.schema.schema"}

examples/django_channels2/django_channels2/schema.py

@@ -1,8 +1,4 @@
-from django.conf.urls import url
-from django.contrib import admin
+from django.urls import path
 from graphene_django.views import GraphQLView
 
-urlpatterns = [
-    url(r"^admin/", admin.site.urls),
-    url(r"^graphql/?$", GraphQLView.as_view(graphiql=True)),
-]
+urlpatterns = [path("graphql", GraphQLView.as_view(graphiql=True))]