Merge pull request graphql-python#4 from colanconnon/django-channels

basic django channels example working

.gitignore

@@ -63,4 +63,6 @@ target/
 .DS_Store
 
 .mypy_cache/
-.vscode/
+.vscode/
+
+*.sqlite3

README.md

@@ -128,3 +128,78 @@ schema = graphene.Schema(query=Query, subscription=Subscription)
 ```
 
 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
+
+```python
+ CHANNELS_WS_PROTOCOLS = ["graphql-ws", ]
+ CHANNEL_LAYERS = {
+ "default": {
+ "BACKEND": "asgiref.inmemory.ChannelLayer",
+ "ROUTING": "django_subscriptions.urls.channel_routing",
+ },
+
+ }
+```
+
+Setup 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
+)
+
+
+````
+
+Setup your schema in settings.py
+
+```python
+GRAPHENE = {
+ 'SCHEMA': 'path.to.schema'
+}
+```
+
+and finally add the channel routes
+
+```python
+from channels.routing import route_class
+from graphql_ws.django_channels import GraphQLSubscriptionConsumer
+
+channel_routing = [
+ route_class(GraphQLSubscriptionConsumer, path=r"^/subscriptions"),
+]
+```

examples/django_subscriptions/django_subscriptions/asgi.py

@@ -0,0 +1,6 @@
+import os
+from channels.asgi import get_channel_layer
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_subscriptions.settings")
+
+channel_layer = get_channel_layer()

examples/django_subscriptions/django_subscriptions/schema.py

@@ -0,0 +1,23 @@
+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)

examples/django_subscriptions/django_subscriptions/settings.py

@@ -0,0 +1,137 @@
+"""
+Django settings for django_subscriptions project.
+
+Generated by 'django-admin startproject' using Django 1.11.6.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.11/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.11/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/1.11/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'fa#kz8m$l6)4(np9+-j_-z!voa090mah!s9^4jp=kj!^nwdq^c'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+ 'django.contrib.admin',
+ 'django.contrib.auth',
+ 'django.contrib.contenttypes',
+ 'django.contrib.sessions',
+ 'django.contrib.messages',
+ 'django.contrib.staticfiles',
+ 'channels',
+]
+
+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_subscriptions.urls'
+
+TEMPLATES = [
+ {
+ 'BACKEND': 'django.template.backends.django.DjangoTemplates',
+ 'DIRS': [],
+ 'APP_DIRS': True,
+ 'OPTIONS': {
+ '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_subscriptions.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.11/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/1.11/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/1.11/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/1.11/howto/static-files/
+
+STATIC_URL = '/static/'
+CHANNELS_WS_PROTOCOLS = ["graphql-ws", ]
+CHANNEL_LAYERS = {
+ "default": {
+ "BACKEND": "asgi_redis.RedisChannelLayer",
+ "CONFIG": {
+ "hosts": [("localhost", 6379)],
+ },
+ "ROUTING": "django_subscriptions.urls.channel_routing",
+ },
+
+}
+
+
+GRAPHENE = {
+ 'SCHEMA': 'django_subscriptions.schema.schema'
+}

examples/django_subscriptions/django_subscriptions/template.py

@@ -0,0 +1,125 @@
+
+from string import Template
+
+
+def render_graphiql():
+ return Template('''
+<!DOCTYPE html>
+<html>
+<head>
+ <meta charset="utf-8" />
+ <title>GraphiQL</title>
+ <meta name="robots" content="noindex" />
+ <style>
+ html, body {
+ height: 100%;
+ margin: 0;
+ overflow: hidden;
+ width: 100%;
+ }
+ </style>
+ <link href="https://cdnjs.cloudflare.com/ajax/libs/graphiql/0.11.10/graphiql.css" rel="stylesheet" />
+ <script src="//cdn.jsdelivr.net/fetch/0.9.0/fetch.min.js"></script>
+ <script src="//cdn.jsdelivr.net/react/15.0.0/react.min.js"></script>
+ <script src="//cdn.jsdelivr.net/react/15.0.0/react-dom.min.js"></script>
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/graphiql/0.11.10/graphiql.js"></script>
+ <script src="//unpkg.com/subscriptions-transport-ws@${SUBSCRIPTIONS_TRANSPORT_VERSION}/browser/client.js"></script>
+ <script src="//unpkg.com/[email protected]/browser/client.js"></script>
+</head>
+<body>
+ <script>
+ // Collect the URL parameters
+ var parameters = {};
+ window.location.search.substr(1).split('&').forEach(function (entry) {
+ var eq = entry.indexOf('=');
+ if (eq >= 0) {
+ parameters[decodeURIComponent(entry.slice(0, eq))] =
+ decodeURIComponent(entry.slice(eq + 1));
+ }
+ });
+ // Produce a Location query string from a parameter object.
+ function locationQuery(params, location) {
+ return (location ? location: '') + '?' + Object.keys(params).map(function (key) {
+ return encodeURIComponent(key) + '=' +
+ encodeURIComponent(params[key]);
+ }).join('&');
+ }
+ // Derive a fetch URL from the current URL, sans the GraphQL parameters.
+ var graphqlParamNames = {
+ query: true,
+ variables: true,
+ operationName: true
+ };
+ var otherParams = {};
+ for (var k in parameters) {
+ if (parameters.hasOwnProperty(k) && graphqlParamNames[k] !== true) {
+ otherParams[k] = parameters[k];
+ }
+ }
+ var fetcher;
+ if (true) {
+ var subscriptionsClient = new window.SubscriptionsTransportWs.SubscriptionClient('${subscriptionsEndpoint}', {
+ reconnect: true
+ });
+ fetcher = window.GraphiQLSubscriptionsFetcher.graphQLFetcher(subscriptionsClient, graphQLFetcher);
+ } else {
+ fetcher = graphQLFetcher;
+ }
+ // We don't use safe-serialize for location, because it's not client input.
+ var fetchURL = locationQuery(otherParams, '${endpointURL}');
+ // Defines a GraphQL fetcher using the fetch API.
+ function graphQLFetcher(graphQLParams) {
+ return fetch(fetchURL, {
+ method: 'post',
+ headers: {
+ 'Accept': 'application/json',
+ 'Content-Type': 'application/json',
+ },
+ body: JSON.stringify(graphQLParams),
+ credentials: 'include',
+ }).then(function (response) {
+ return response.text();
+ }).then(function (responseBody) {
+ try {
+ return JSON.parse(responseBody);
+ } catch (error) {
+ return responseBody;
+ }
+ });
+ }
+ // When the query and variables string is edited, update the URL bar so
+ // that it can be easily shared.
+ function onEditQuery(newQuery) {
+ parameters.query = newQuery;
+ updateURL();
+ }
+ function onEditVariables(newVariables) {
+ parameters.variables = newVariables;
+ updateURL();
+ }
+ function onEditOperationName(newOperationName) {
+ parameters.operationName = newOperationName;
+ updateURL();
+ }
+ function updateURL() {
+ history.replaceState(null, null, locationQuery(parameters) + window.location.hash);
+ }
+ // Render <GraphiQL /> into the body.
+ ReactDOM.render(
+ React.createElement(GraphiQL, {
+ fetcher: fetcher,
+ onEditQuery: onEditQuery,
+ onEditVariables: onEditVariables,
+ onEditOperationName: onEditOperationName,
+ }),
+ document.body
+ );
+ </script>
+</body>
+</html>''').substitute(
+ GRAPHIQL_VERSION='0.11.10',
+ SUBSCRIPTIONS_TRANSPORT_VERSION='0.7.0',
+ subscriptionsEndpoint='ws:https://localhost:8000/subscriptions',
+ # subscriptionsEndpoint='ws:https://localhost:5000/',
+ endpointURL='/graphql',
+ )