Skip to content
GraphQL primitives for Python
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
docs
examples
py_gql
tests
.editorconfig
.gitignore
.pylintrc
CHANGES.md
LICENSE
MANIFEST.in
README.md
dev-requirements.txt
requirements.txt
setup.cfg
setup.py
tasks.py
test-requirements.txt
tox.ini

README.md

py-gql

CircleCI Codecov PyPI PyPI - Python Version PyPI - Wheel Read the Docs (version)

py-gql is a pure python GraphQL implementation aimed at creating GraphQL servers.

It supports:

  • Parsing the GraphQL query language and schema definition language.
  • Building a GraphQL type schema programatically and from Schema Definition files (including support for schema directives).
  • Validating and Executing a GraphQL request against a type schema.

Quick links

Installation

pip install py-gql

For more details see install.rst.

Usage & Examples

Hello World

from py_gql import build_schema, graphql_blocking

schema = build_schema(
    """
    type Query {
        hello(value: String = "world"): String!
    }
    """
)


@schema.resolver("Query.hello")
def resolve_hello(*_, value):
    return f"Hello {value}!"


result = graphql_blocking(schema, '{ hello(value: "Foo") }')
assert result.response() == {
    "data": {
        "hello": "Hello Foo!"
    }
}

For more usage examples, you can refer to the User Guide and some more involved examples available in the examples folder.

The tests should also provide some contrived exmaples.

Goals & Status

This project was initially born as an experiment / learning project following some frustration with graphql-core and Graphene I encountered at work.

The main goals were originally to:

  • Get a deeper understanding of GraphQL

  • Provide an alternative to graphql-core which:

    • tracks the latest version of the spec (which graphql-core didn't)
    • does so without being a port of the JS code which leads to some weird edge case when we tried to extend the library
    • keeps support for Python 2 (which graphql-core-next) didn't (this isn't a focu anymore and version 0.2 dropped Python 2 support).
    • (subjective) attempts to be a bit more usable for our use cases, the ideal result would sit somewhere in between Graphene and graphql-core
    • makes it easier for us to build / include some extra tooling such as custom tracing, custom validation and SDL based tools as well as builder infrastructure to support easily implementing graphql layers over existing data layers (such as ORM).

Not all these points are satisfied yet but py-gql should be ready for general use. It is however still in a fairly experimental phase and to reflect that versions are still in the 0.x.y.The API is still subject to change as different part of the codebase are iterated on and are getting more use against production codebases.

Development

Make sure you are using Python 3.6+ (you can run the tests under 3.5 but black other development tasks are not guaranteed to work).

Clone this repo and create a virtualenv before installing the development dependencies:

git clone git@github.com:lirsacc/py-gql.git
python -m venv $WORKON_HOME/py-gql --copies
pip install -U -r dev-requirements.txt

From there, most development tasks are available through invoke.

Use inv -l to list all available tasks and inv {TASKS} --help to get help on a specific task.

Branches

  • The last tag should correspond to the latest release version
  • master contains unreleased changes that are planned to be released
  • dev is used for experimenting and hard changes such as rebase and force pushed should be expected (I plan to move to using specific feature branches for better organisation)
You can’t perform that action at this time.