A dead-simple GraphQL client that supports subscriptions over websockets
Project description
py-graphql-client
Dead-simple to use GraphQL client over websocket. Using the apollo-transport-ws protocol.
Install
pip install py-graphql-client
Examples
Setup subscriptions super easily
from graphql_client import GraphQLClient
query = """
subscription {
notifications {
id
title
content
}
}
"""
with GraphQLClient('ws://localhost:8080/graphql') as client:
sub_id = client.subscribe(query, callback=callback)
# do other stuff
# ...
# later stop the subscription
client.stop_subscribe(sub_id)
def callback(_id, data):
print("got new data..")
print(f"msg id: {_id}. data: {data}")
Variables can be passed
from graphql_client import GraphQLClient
query = """
subscription ($limit: Int!) {
notifications (order_by: {created: "desc"}, limit: $limit) {
id
title
content
}
}
"""
with GraphQLClient('ws://localhost:8080/graphql') as client:
sub_id = client.subscribe(query, variables={'limit': 10}, callback=callback)
# ...
def callback(_id, data):
print("got new data..")
print(f"msg id: {_id}. data: {data}")
Headers can be passed too
from graphql_client import GraphQLClient
query = """
subscription ($limit: Int!) {
notifications (order_by: {created: "desc"}, limit: $limit) {
id
title
content
}
}
"""
with GraphQLClient('ws://localhost:8080/graphql') as client:
sub_id = client.subscribe(query,
variables={'limit': 10},
headers={'Authorization': 'Bearer xxxx'},
callback=callback)
...
client.stop_subscribe(sub_id)
def callback(_id, data):
print("got new data..")
print(f"msg id: {_id}. data: {data}")
Normal queries and mutations work too
from graphql_client import GraphQLClient
query = """
query ($limit: Int!) {
notifications (order_by: {created: "desc"}, limit: $limit) {
id
title
content
}
}
"""
with GraphQLClient('ws://localhost:8080/graphql') as client:
res = client.query(query, variables={'limit': 10}, headers={'Authorization': 'Bearer xxxx'})
print(res)
Without the context manager API
from graphql_client import GraphQLClient
query = """
query ($limit: Int!) {
notifications (order_by: {created: "desc"}, limit: $limit) {
id
title
content
}
}
"""
client = GraphQLClient('ws://localhost:8080/graphql')
res = client.query(query, variables={'limit': 10}, headers={'Authorization': 'Bearer xxxx'})
print(res)
client.close()
TODO
- support http as well
- should use asyncio websocket library?
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for py_graphql_client-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | df5d0ed3151025b959405dd6caed7dcb772a7180e8181abf8cc2a66b6aa8d7bb |
|
MD5 | 5bf091ae66aff171534f2d1d94f66454 |
|
BLAKE2b-256 | adfa358c3dd0dd59c36d05bb2fc406b55f30e33e350025d01efb61544333c7f0 |