graphql-ws-next
A GraphQL WebSocket server and client to facilitate GraphQL queries, mutations and subscriptions over WebSocket (for Python 3.6+). This code is based on the current implementation of subscriptions-transport-ws.
Getting Started
Start by installing the package using pip:
Or, by using your favorite package manager, like Poetry:
With aiohttp
Usage with aiohttp is simple:
For other frameworks
Adding support for other web frameworks is simple. A framework must provide a concrete implementation of graphql_ws.abc.AbstractConnectionContext, and then it’s ready to use with the SubscriptionServer.
Usage
Using apollo-link-ws you can opt to use websockets for queries and mutations in addition to subscriptions.
Use it with GraphiQL
Look in the demo<./demo>_ directory to see usage examples for GraphiQL. Due to the implementation of the javascript client for GraphiQL (GraphiQL-Subscriptions-Fetcher), queries and mutations will not be handled over websocket.
Contributing
This project uses Poetry, so to contribute, simply fork and clone this repository, and then set up your virtual environment using:
If you don’t yet have Poetry installed, please follow the documentation for installation.
Code formatting is done via black, and code should be well-typed using mypy.
License
This package is licensed under the MIT License.
Metadata
Release files for graphql-ws-next 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| graphql-ws-next-1.0.0.tar.gz | 7.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| graphql_ws_next-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 29.1 kB
Release files / graphql-ws-next-1.0.0.tar.gz
| Download URL | graphql-ws-next-1.0.0.tar.gz |
|---|---|
| Size | 7.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
423ce220833b55fc571d3a8c3b733c908672aecaba2546703eb24acd61dcfeb7
|
|
BLAKE2b-256 checksum How to use checksums |
9b0890ba55f8ccdcc877f3ea5fcae10007955db64daa82bf4db915f346c52a4b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/0.11.5 CPython/3.7.0 Darwin/17.7.0
|
Release files / graphql_ws_next-1.0.0-py3-none-any.whl
| Download URL | graphql_ws_next-1.0.0-py3-none-any.whl |
|---|---|
| Size | 21.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d76a019ea64730af77f3a0ff3e15de62502b132a4ae3a02628fca3725f2bf907
|
|
BLAKE2b-256 checksum How to use checksums |
621d3323cf6f7acab2a74d3adaf28c4f3b8ba360560af0591341b4fa626f252e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/0.11.5 CPython/3.7.0 Darwin/17.7.0
|
Security for graphql-ws-next 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.