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

Uploaded Source

Built Distribution

gql-3.5.0b6-py2.py3-none-any.whl (72.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: gql-3.5.0b6.tar.gz
  • Upload date:
  • Size: 177.0 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.0b6.tar.gz
Algorithm Hash digest
SHA256 7ec2adfab1aafba938b0668c4f4578c1aa90df587b0c792b48b4a7c873c1d9aa
MD5 fb28257320fe88d050ef3ad72a4bccf1
BLAKE2b-256 c3391ea45f48cd66678d7672d21ad4e6cd5aee6b901edc6c624fd0956cdffc9a

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: gql-3.5.0b6-py2.py3-none-any.whl
  • Upload date:
  • Size: 72.6 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.0b6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e8631e0875a69c5b9a4501ad4c5387e3a3e3ff89bb2aa54c856a358a70431802
MD5 d49ed047cf3f43bcc8e835574777e8fe
BLAKE2b-256 638be7e0b94a8182b4f8edccb3f08357f847519d7a0163ea7b1b87481a599ec3

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