Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 391 Commits
.github		.github
docs		docs
gql		gql
tests		tests
.gitignore		.gitignore
.readthedocs.yaml		.readthedocs.yaml
CODEOWNERS		CODEOWNERS
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
Makefile		Makefile
README.md		README.md
pyproject.toml		pyproject.toml
setup.cfg		setup.cfg
setup.py		setup.py
tox.ini		tox.ini

Repository files navigation

GQL

This is a GraphQL client for Python.Plays nicely withgraphene,graphql-core,graphql-js and any other GraphQL implementationcompatible with theGraphQL specification.

GQL architecture is inspired byReact-Relay andApollo-Client.

Documentation

The complete documentation for GQL can be found atgql.readthedocs.io.

Features

Execute GraphQL queries usingdifferent protocols:
- http
- websockets:
  - apollo or graphql-ws protocol
  - Phoenix channels
  - AWS AppSync realtime protocol (experimental)
Possibility tovalidate the queries locally using a GraphQL schema provided locally or fetched from the backend using an instrospection query
Supports GraphQL queries, mutations andsubscriptions
Supportssync orasync usage,allowing concurrent requests
SupportsFile uploads
SupportsCustom scalars / Enums
SupportsBatching requests
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:

# Quotes may be required on certain shells such as zsh.pip install"gql[all]"

NOTE: See alsothe documentation to install GQL with less extra dependencies depending on the transports you would like to use or for alternative installation methods.

Usage

Sync usage

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 somepython environments (as with Jupyter which uses IPython) an asyncio event loop is created for you. In that case youshould use instead theasync usage example.

Async usage

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())