Client library for making graphql calls
Project description
A pythonic interface for making requests to a GraphQL server using standard library or pydantic dataclasses to spare you from string manipulation.
Features
Use standard library dataclasses to specify graphql parameters and responses
Use pydantic dataclasses to specify graphql parameters and responses that have type validation
Create and execute GraphQL Queries based upon typed models
Create and execute GraphQL Mutations based upon typed models
Async support
Installation
pip install gqlclientwith asyncio support
pip install gqlclient[async]Examples
Query
from pydantic.dataclasses import dataclass
from gqlclient import GraphQLClient
@dataclass
class Parameters:
attr_one: str
attr_two: int
@dataclass
class Response:
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)
#{"baseType"{"attr_three":5, "attr_four":"bar"}}Mutation
from pydantic.dataclasses import dataclass
from gqlclient import GraphQLClient
@dataclass
class Parameters:
attr_one: str
attr_two: int
@dataclass
class Response:
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)
#{"baseMutation": {"ok": true, "Response": {"attr_three":5, "attr_four":"bar"} }}Release history Release notifications | RSS feed
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.8.0.tar.gz
(10.7 kB
view details)
File details
Details for the file gqlclient-0.8.0.tar.gz.
File metadata
- Download URL: gqlclient-0.8.0.tar.gz
- Upload date:
- Size: 10.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 73b2562859f09ee7fd5eae8641015426c550ff02d0964e6d7441c5316047f1ff |
|
| MD5 | ccfd22829897a117b8477801d1a184b8 |
|
| BLAKE2b-256 | 258991717871c9a796333857727378de89a31482b78fb40048e2362805f2cae0 |
