Update readme

Author: SmileyChris

README.rst

@@ -1,14 +1,23 @@
+==========
 GraphQL WS
 ==========
 
-Websocket server for GraphQL subscriptions.
+Websocket backend for GraphQL subscriptions.
+
+Supports the following application servers:
+
+Python 3 application servers, using asyncio:
+
+    * `aiohttp`_
+    * `websockets compatible servers`_ such as Sanic
+      (via `websockets <https://github.com/aaugustin/websockets/>`__ library)
 
-Currently supports:
+Python 2 application servers:
+
+    * `Gevent compatible servers`_ such as Flask
+    * `Django v1.x`_
+      (via `channels v1.x <https://channels.readthedocs.io/en/1.x/inshort.html>`__)
 
-* `aiohttp <https://github.com/graphql-python/graphql-ws#aiohttp>`__
-* `Gevent <https://github.com/graphql-python/graphql-ws#gevent>`__
-* Sanic (uses `websockets <https://github.com/aaugustin/websockets/>`__
-  library)
 
 Installation instructions
 =========================
@@ -19,21 +28,54 @@ For instaling graphql-ws, just run this command in your shell
 
     pip install graphql-ws
 
+
 Examples
---------
+========
+
+Python 3 servers
+----------------
+
+Create a subscribable schema like this:
+
+.. code:: python
+
+    import asyncio
+    import graphene
+
+
+    class Query(graphene.ObjectType):
+        hello = graphene.String()
+
+        @static_method
+        def resolve_hello(obj, info, **kwargs):
+            return "world"
+
+
+    class Subscription(graphene.ObjectType):
+        count_seconds = graphene.Float(up_to=graphene.Int())
+
+        async def resolve_count_seconds(root, info, up_to):
+            for i in range(up_to):
+                yield i
+                await asyncio.sleep(1.)
+            yield up_to
+
+
+    schema = graphene.Schema(query=Query, subscription=Subscription)
 
 aiohttp
 ~~~~~~~
 
-For setting up, just plug into your aiohttp server.
+Then just plug into your aiohttp server.
 
 .. code:: python
 
     from graphql_ws.aiohttp import AiohttpSubscriptionServer
-
+    from .schema import schema
 
     subscription_server = AiohttpSubscriptionServer(schema)
 
+
     async def subscriptions(request):
         ws = web.WebSocketResponse(protocols=('graphql-ws',))
         await ws.prepare(request)
@@ -47,21 +89,26 @@ For setting up, just plug into your aiohttp server.
 
     web.run_app(app, port=8000)
 
-Sanic
-~~~~~
+You can see a full example here:
+https://github.com/graphql-python/graphql-ws/tree/master/examples/aiohttp
+
 
-Works with any framework that uses the websockets library for it’s
-websocket implementation. For this example, plug in your Sanic server.
+websockets compatible servers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Works with any framework that uses the websockets library for its websocket
+implementation. For this example, plug in your Sanic server.
 
 .. code:: python
 
     from graphql_ws.websockets_lib import WsLibSubscriptionServer
-
+    from . import schema
 
     app = Sanic(__name__)
 
     subscription_server = WsLibSubscriptionServer(schema)
 
+
     @app.websocket('/subscriptions', subprotocols=['graphql-ws'])
     async def subscriptions(request, ws):
         await subscription_server.handle(ws)
@@ -70,80 +117,73 @@ websocket implementation. For this example, plug in your Sanic server.
 
     app.run(host="0.0.0.0", port=8000)
 
-And then, plug into a subscribable schema:
+
+Python 2  servers
+-----------------
+
+Create a subscribable schema like this:
 
 .. code:: python
 
-    import asyncio
     import graphene
+    from rx import Observable
 
 
     class Query(graphene.ObjectType):
-        base = graphene.String()
+        hello = graphene.String()
+
+        @static_method
+        def resolve_hello(obj, info, **kwargs):
+            return "world"
 
 
     class Subscription(graphene.ObjectType):
         count_seconds = graphene.Float(up_to=graphene.Int())
 
-        async def resolve_count_seconds(root, info, up_to):
-            for i in range(up_to):
-                yield i
-                await asyncio.sleep(1.)
-            yield up_to
+        async 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)
 
-You can see a full example here:
-https://github.com/graphql-python/graphql-ws/tree/master/examples/aiohttp
-
-Gevent
-~~~~~~
+Gevent compatible servers
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
-For setting up, just plug into your Gevent server.
+Then just plug into your Gevent server, for example, Flask:
 
 .. code:: python
 
+    from flask_sockets import Sockets
+    from graphql_ws.gevent import GeventSubscriptionServer
+    from schema import schema
+
     subscription_server = GeventSubscriptionServer(schema)
     app.app_protocol = lambda environ_path_info: 'graphql-ws'
 
+
     @sockets.route('/subscriptions')
     def echo_socket(ws):
         subscription_server.handle(ws)
         return []
 
-And then, plug into a subscribable schema:
-
-.. code:: python
-
-    import graphene
-    from rx import Observable
-
-
-    class Query(graphene.ObjectType):
-        base = graphene.String()
-
-
-    class Subscription(graphene.ObjectType):
-        count_seconds = graphene.Float(up_to=graphene.Int())
-
-        async 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)
-
 You can see a full example here:
 https://github.com/graphql-python/graphql-ws/tree/master/examples/flask_gevent
 
-Django Channels
-~~~~~~~~~~~~~~~
+Django v1.x
+~~~~~~~~~~~
 
-First ``pip install channels`` and it to your django apps
+For Django v1.x and Django Channels v1.x, setup your schema in ``settings.py``
 
-Then add the following to your settings.py
+.. code:: python
+
+    GRAPHENE = {
+        'SCHEMA': 'yourproject.schema.schema'
+    }
+
+Then ``pip install "channels<1"`` and it to your django apps, adding the
+following to your ``settings.py``
 
 .. code:: python
 
@@ -153,53 +193,9 @@ Then add the following to your settings.py
             "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
+And finally add the channel routes
 
 .. code:: python
 
@@ -209,3 +205,6 @@ and finally add the channel routes
     channel_routing = [
         route_class(GraphQLSubscriptionConsumer, path=r"^/subscriptions"),
     ]
+
+You can see a full example here:
+https://github.com/graphql-python/graphql-ws/tree/master/examples/django_subscriptions

setup.cfg

@@ -2,7 +2,7 @@
 [metadata]
 name = graphql-ws
 version = 0.3.1
-description = Websocket server for GraphQL subscriptions
+description = Websocket backend for GraphQL subscriptions
 long_description = file: README.rst, CHANGES.rst
 author = Syrus Akbary
 author_email = [email protected]