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

Uploaded Source

Built Distribution

gql-3.5.0b4-py2.py3-none-any.whl (69.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: gql-3.5.0b4.tar.gz
  • Upload date:
  • Size: 164.0 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.0b4.tar.gz
Algorithm Hash digest
SHA256 6b853c42d1018913281cc07557314fcd2a362f2da306e831033bda2fa72d191a
MD5 e1cdf869f6156e69274bd3c68bd99231
BLAKE2b-256 f8cc442255cd6ed9ff126ff1a0bd7a7d4509614c7f0cda7aa9e92355b042761b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: gql-3.5.0b4-py2.py3-none-any.whl
  • Upload date:
  • Size: 69.0 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.0b4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5f2e5d55d3b30d4d94fcd236e9766e00f4db1e94987de5321cb4c075741620fb
MD5 eb1172c5560d48046c0d221010e64df5
BLAKE2b-256 679dbda883d3da70b9efea7994de5fe4f0968a29e2888ccf1fa54a9e70eec3ec

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