270 GitHub stars and counting — graphql-python/graphql-ws is a Python project TopGit is tracking across repositories on the platform. GraphQL websockets
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
* `aiohttp`_
* `websockets compatible servers`_ such as Sanic
(via `websockets <https://github.com/aaugustin/websockets/>`__ library)
* `Django v2+`_
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>`__)
Installation instructions
For instaling graphql-ws, just run this command in your shell
.. code:: bash
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()
@staticmethod
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
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)
await subscription_server.handle(ws)
return ws
app = web.Application()
app.router.add_get('/subscriptions', subscriptions)
web.run_app(app, port=8000)
You can see a full example here:
https://github.com/graphql-python/graphql-ws/tree/master/examples/aiohttp
websockets compatible servers
Works with any framework that uses the websockets library for its websocket
implementation. For this example, plug in your Sanic server.
Set up with Django Channels just takes three steps:
Install the apps
Set up your schema
Configure the channels router application
First pip install channels and it to your INSTALLED_APPS. If you
want graphiQL, install the graphql_ws.django app before
graphene_django to serve a graphiQL template that will work with
websockets:
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
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 <http://localhost:8000/graphql>__ to test!
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 []
You can see a full example here:
https://github.com/graphql-python/graphql-ws/tree/master/examples/flask_gevent
Django v1.x
~~~~~~~~~~~
For Django v1.x and Django Channels v1.x, setup your schema in ``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
CHANNELS_WS_PROTOCOLS = ["graphql-ws", ]
CHANNEL_LAYERS = {
"default": {
"BACKEND": "asgiref.inmemory.ChannelLayer",
"ROUTING": "django_subscriptions.urls.channel_routing",
},
}
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"),
]
You can see a full example here:
https://github.com/graphql-python/graphql-ws/tree/master/examples/django_subscriptions
TopGit's last sync did not record any GitHub topics for graphql-python/graphql-ws. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on graphql-python/graphql-ws?
The most recent commit recorded on graphql-python/graphql-ws was 2.8 years ago, based on the GitHub push timestamp. The repository has 84 forks — one of the better signals of community interest.
How many stars does graphql-python/graphql-ws have?
graphql-python/graphql-ws has 270 GitHub stars — refresh the page for the live number, or check github.com/graphql-python/graphql-ws. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What language is graphql-python/graphql-ws written in?
graphql-python/graphql-ws is written primarily in Python. GitHub's language field is based on the largest share of bytes in the default branch.
Where do I read more about graphql-python/graphql-ws?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/graphql-python/graphql-ws is the definitive source.
Read full README in the tab above.
Curious whether graphql-ws is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about graphql-ws.