jpavlav / gql

A GraphQL client in Python

GQL

This is a GraphQL client for Python 3.6+. Plays nicely with graphene, graphql-core, graphql-js and any other GraphQL implementation compatible with the spec.

GQL architecture is inspired by React-Relay and Apollo-Client.

Documentation

The complete documentation for GQL can be found at gql.readthedocs.io.

Features

• Execute GraphQL queries using different protocols:
  • http
  • websockets:
    • apollo or graphql-ws protocol
    • Phoenix channels
    • AWS AppSync realtime protocol (experimental)
• Possibility to validate the queries 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
• gql-cli script to execute GraphQL queries or download schemas from the command line
• DSL module to compose GraphQL queries dynamically

Installation

You can install GQL with all the optional dependencies using pip:

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.

Usage

Basic usage

from gql import gql, Client
from gql.transport.aiohttp import AIOHTTPTransport

# Select your transport with a defined url endpoint
transport = AIOHTTPTransport(url="https://countries.trevorblades.com/")

# Create a GraphQL client using the defined transport
client = Client(transport=transport, fetch_schema_from_transport=True)

# Provide a GraphQL query
query = gql(
    """
    query getContinents {
      continents {
        code
        name
      }
    }
"""
)

# Execute the query on the transport
result = 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.

Contributing

See CONTRIBUTING.md

License

MIT License