This is a GraphQL client for Python.
Plays nicely with graphene, graphql-core, graphql-js and any other GraphQL implementation
compatible with the GraphQL specification.
GQL architecture is inspired by React-Relay and Apollo-Client.
The complete documentation for GQL can be found at gql.readthedocs.io.
- Execute GraphQL requests using different protocols:
- http
- including the multipart protocol for subscriptions
- websockets:
- apollo or graphql-ws protocol
- Phoenix channels
- AWS AppSync realtime protocol
- http
- Possibility to validate the requests locally using a GraphQL schema provided locally or fetched from the backend using an instrospection query
- Supports GraphQL queries, mutations and subscriptions
- Supports sync or async usage, allowing concurrent requests
- Supports File uploads
- Supports Custom scalars / Enums
- Supports Batching requests
- gql-cli script to execute GraphQL queries or download schemas from the command line
- DSL module to compose GraphQL queries dynamically
You can install GQL with all the optional dependencies using pip:
# Quotes may be required on certain shells such as zsh.
pip install "gql[all]"NOTE: See also the documentation to install GQL with less extra dependencies depending on the transports you would like to use or for alternative installation methods.
fromgqlimportClient, gqlfromgql.transport.aiohttpimportAIOHTTPTransport# Select your transport with a defined url endpointtransport=AIOHTTPTransport(url="https://countries.trevorblades.com/")
# Create a GraphQL client using the defined transportclient=Client(transport=transport)
# Provide a GraphQL queryquery=gql(
""" query getContinents { continents { code name } }"""
)
# Execute the query on the transportresult=client.execute(query)
print(result)Executing the above code should output the following result:
$ python basic_example.py
{'continents': [{'code': 'AF', 'name': 'Africa'}, {'code': 'AN', 'name': 'Antarctica'}, {'code': 'AS', 'name': 'Asia'}, {'code': 'EU', 'name': 'Europe'}, {'code': 'NA', 'name': 'North America'}, {'code': 'OC', 'name': 'Oceania'}, {'code': 'SA', 'name': 'South America'}]}
WARNING: Please note that this basic example won't work if you have an asyncio event loop running. In some python environments (as with Jupyter which uses IPython) an asyncio event loop is created for you. In that case you should use instead the async usage example.
importasynciofromgqlimportClient, gqlfromgql.transport.aiohttpimportAIOHTTPTransportasyncdefmain():
# Select your transport with a defined url endpointtransport=AIOHTTPTransport(url="https://countries.trevorblades.com/graphql")
# Create a GraphQL client using the defined transportclient=Client(transport=transport)
# Provide a GraphQL queryquery=gql(
""" query getContinents { continents { code name } } """
)
# Using `async with` on the client will start a connection on the transport# and provide a `session` variable to execute queries on this connectionasyncwithclientassession:
# Execute the queryresult=awaitsession.execute(query)
print(result)
asyncio.run(main())See CONTRIBUTING.md