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.0b0.tar.gz (161.2 kB view details)

Uploaded Source

Built Distribution

gql-3.5.0b0-py2.py3-none-any.whl (68.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: gql-3.5.0b0.tar.gz
  • Upload date:
  • Size: 161.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.15

File hashes

Hashes for gql-3.5.0b0.tar.gz
Algorithm Hash digest
SHA256 1df0593c36558fcd0edfe92d9f42ca12cda79d109cc3a38dea22ab1077b310f0
MD5 155e3ef14e91bc73129d074aede3f211
BLAKE2b-256 1ad8362fa8cecc7b29777e1a414f7751dee56753ff72cbfbb3ab5fe21ad688bc

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for gql-3.5.0b0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 742c726e5145fdb0b8813ee8579b44f641d22db9cddec3c29eb2b100823eb833
MD5 4e2dd26a089ff3d6d81ba7e896356061
BLAKE2b-256 252dd2b7a970e336d92af6f95d70b46eb1b210fa69cbd3fe2ca8257d5ccaf7f3

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