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:

# 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.

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.3.tar.gz (180.5 kB view details)

Uploaded Source

Built Distribution

gql-3.5.3-py2.py3-none-any.whl (74.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file gql-3.5.3.tar.gz.

File metadata

  • Download URL: gql-3.5.3.tar.gz
  • Upload date:
  • Size: 180.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for gql-3.5.3.tar.gz
Algorithm Hash digest
SHA256 393b8c049d58e0d2f5461b9d738a2b5f904186a40395500b4a84dd092d56e42b
MD5 90cd474ef456b8f632f0ca97dd884ac5
BLAKE2b-256 34ed44ffd30b06b3afc8274ee2f38c3c1b61fe4740bf03d92083e43d2c17ac77

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for gql-3.5.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e1fcbde2893fcafdd28114ece87ff47f1cc339a31db271fc4e1d528f5a1d4fbc
MD5 3f7b412f8698bf916c2797e10be64116
BLAKE2b-256 cb502f4e99b216821ac921dbebf91c644ba95818f5d07857acadee17220221f3

See more details on using hashes here.

Supported by

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