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.

Files for gqlclient, version 0.6
Filename, size & hash File type Python version Upload date
gqlclient-0.6.tar.gz (9.0 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page