graphqlclient

0.2.4 verified Fri May 01 auth: no python maintenance

A minimal GraphQL client for Python 2.7+ (and 3.x) that provides a simple way to execute queries and mutations. Current version 0.2.4, last released in 2018. The library is in maintenance mode with no active development.

pip install graphqlclient

Common errors

error AttributeError: module 'graphqlclient' has no attribute 'GraphQLClient' ↓

cause Incorrect import: using 'from graphql_client import ...' or 'import graphqlclient' then accessing graphqlclient.GraphQLClient

fix

Use: from graphqlclient import GraphQLClient

error TypeError: string indices must be integers, not 'str' when trying to access result['data'] ↓

cause execute() returns a raw JSON string; you must parse it first.

fix

import json; result = json.loads(client.execute(query)); print(result['data'])

error requests.exceptions.InvalidSchema: No connection adapters were found for 'http://localhost:4000/graphql' ↓

cause The library only supports http/https URLs but your URL may have a typo or missing scheme.

fix

Ensure the URL starts with http:// or https://

Warnings

gotcha The client does not support variables in a structured way; you must embed them directly in the query string. ↓

fix Use f-strings or string formatting to manually interpolate variables into the query.

gotcha Error handling is minimal: the execute method returns raw JSON string, not a parsed dict. You must call json.loads() yourself. ↓

fix import json; result = json.loads(client.execute(query))

deprecated This library is no longer maintained. For production use, consider a more modern client like gql or sgqlc. ↓

fix Migrate to gql (pip install gql) with an AIOHTTP or Requests transport.

gotcha Authentication headers must be set via the init method, not through a dedicated auth parameter. ↓

fix client = GraphQLClient('https://api.github.com/graphql'); client.inject_token('bearer YOUR_TOKEN')

Imports

GraphQLClient

wrong

from graphql_client import GraphQLClient

correct

from graphqlclient import GraphQLClient

Wrong hyphen vs underscore

GraphQLClient

wrong

import graphqlclient.GraphQLClient

correct

from graphqlclient import GraphQLClient

Submodule doesn't exist

Quickstart

Create a client with the endpoint URL, then execute a GraphQL query string.

from graphqlclient import GraphQLClient

client = GraphQLClient('https://api.example.com/graphql')
result = client.execute('''
query {
  viewer {
    login
  }
}''')
print(result)