Skip to main content

GraphQL client for Python

Project description

GQL

This is a GraphQL client for Python 3.7+. 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.

GitHub-Actions pyversion pypi Anaconda-Server Badge codecov

Documentation

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

Features

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gql-3.5.0b2.tar.gz (162.1 kB view details)

Uploaded Source

Built Distribution

gql-3.5.0b2-py2.py3-none-any.whl (68.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file gql-3.5.0b2.tar.gz.

File metadata

  • Download URL: gql-3.5.0b2.tar.gz
  • Upload date:
  • Size: 162.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for gql-3.5.0b2.tar.gz
Algorithm Hash digest
SHA256 09a20560d4b5c56967b0d5acc4941dcf234b4ef871845d5e66ecbce716bc3c47
MD5 e1f1d962c45c223fed24c22b2a79eff2
BLAKE2b-256 7d884b75a6395a5c6903b8aa3a9921e7033aef4e99057f244c4c57ff10c9e616

See more details on using hashes here.

Provenance

File details

Details for the file gql-3.5.0b2-py2.py3-none-any.whl.

File metadata

  • Download URL: gql-3.5.0b2-py2.py3-none-any.whl
  • Upload date:
  • Size: 68.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for gql-3.5.0b2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 be398a421b022e0c62fd57689ec6ca0424a5dd5dd6bd762dc82df7c081a3913d
MD5 ea27dad76a257700183adf87445742b1
BLAKE2b-256 33a12a7c913a1a34691ed30be5f8fd046786692eeffff173129a159384318bb4

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page