Skip to main content

Client library for making graphql calls

Project description

codecov

A pythonic interface for making requests to a GraphQL server using pydantic models to spare you from string manipulation.

Features

  • Use pydantic BaseModel to specify graphql parameters and responses

  • Create and execute GraphQL Queries based upon typed models

  • Create and execute GraphQL Mutations based upon typed models

  • Async support

Installation

pip install gqlclient

with asyncio support

pip install gqlclient[async]

Examples

Query

from pydantic import BaseModel

from gqlclient import GraphQLClient


class Parameters(BaseModel):
    attr_one: str
    attr_two: int


class Response(BaseModel):
    attr_three: int
    attr_four: str

client = GraphQLClient(gql_uri="http://localhost:5000/graphql")
parameters = Parameters(attr_one="foo", attr_two=3)
query = client.get_query(query_base="baseType", query_response_cls=Response, query_parameters=parameters)
print(query)
#{'query': '{baseType(attr_one: "foo", attr_two: 3){attr_three, attr_four} }'}
response = client.execute_gql_query(query_base="baseType", query_response_cls=Response, query_parameters=parameters)
print(response)
#{"data": "baseType"{"attr_three":5, "attr_four":"bar"}}

Mutation

from pydantic import BaseModel

from gqlclient import GraphQLClient


class Parameters(BaseModel):
    attr_one: str
    attr_two: int


class Response(BaseModel):
    attr_three: int
    attr_four: str

client = GraphQLClient(gql_uri="http://localhost:5000/graphql")
parameters = Parameters(attr_one="foo", attr_two=3)
query = client.get_mutation(mutation_base="baseMutation", mutation_response_cls=Response, mutation_parameters=parameters)
print(query)
#{'query': 'mutation baseType {baseType(attr_one: "foo", attr_two: 3){ok, attr_three, attr_four} }', 'operationName': 'baseType'}

response = client.execute_gql_mutation(mutation_base="baseMutation", mutation_response_cls=Response, mutation_parameters=parameters)
print(response)
#{"data": {"baseMutation": {"ok": true, "Response": {"attr_three":5, "attr_four":"bar"} }}

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

gqlclient-0.6rc1.tar.gz (9.0 kB view details)

Uploaded Source

File details

Details for the file gqlclient-0.6rc1.tar.gz.

File metadata

  • Download URL: gqlclient-0.6rc1.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.3

File hashes

Hashes for gqlclient-0.6rc1.tar.gz
Algorithm Hash digest
SHA256 94d7e9681fb04995a1a38fdb4b075df277564d66bf12a9e71f633a959bc8f8b4
MD5 12b73e98eece5600c6bb329f07081999
BLAKE2b-256 a4973e586bc2b2d2d92b8620e6823362b25eee650103f29fb6370e441a765ee7

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