Merge pull request #45 from SmileyChris/master

Update setup configuration and create initial tests

Author: SmileyChris

HISTORY.rst

@@ -2,7 +2,25 @@
 History
 =======
 
+0.3.0 (2018-09-25)
+==================
+
+- Django channels (v1) server (with example app).
+
+- Websockets lib server (with example app).
+
+- Observable aiter server.
+
+
+0.2.0 (2017-11-18)
+==================
+
+- Add gevent subscription server.
+
+- Add example flask gevent app.
+
+
 0.1.0 (2017-10-15)
-------------------
+==================
 
-* First release on PyPI.
+- First release on PyPI.

MANIFEST.in

@@ -3,9 +3,10 @@ include CONTRIBUTING.rst
 include HISTORY.rst
 include LICENSE
 include README.rst
+include tox.ini
 
-recursive-include tests *
-recursive-exclude * __pycache__
-recursive-exclude * *.py[co]
+graft tests
+global-exclude __pycache__
+global-exclude *.py[co]
 
 recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

README.md

@@ -3,9 +3,12 @@ GraphQL WS
 
 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>`__
+Currently supports:
+
+* `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
 =========================
@@ -44,6 +47,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
@@ -110,4 +136,76 @@ And then, plug into a subscribable schema:
     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
+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"),
+    ]

README.rst

@@ -0,0 +1 @@
+db.sqlite3

bin/convert_documentation

@@ -7,6 +7,4 @@
 __version__ = '0.3.1'
 
 
-from .base import BaseConnectionContext, BaseSubscriptionServer
-
-__all__ = ['BaseConnectionContext', 'BaseSubscriptionServer']
+from .base import BaseConnectionContext, BaseSubscriptionServer  # noqa: F401