Please read UPGRADE-v2.0.md to learn how to upgrade to Graphene 2.0.

Graphene

Graphene is a Python library for building GraphQL schemas/types fast and easily.

Easy to use: Graphene helps you use GraphQL in Python without effort.
Relay: Graphene has builtin support for Relay.
Data agnostic: Graphene supports any kind of data source: SQL (Django, SQLAlchemy), NoSQL, custom Python objects, etc. We believe that by providing a complete API you could plug Graphene anywhere your data lives and make your data available through GraphQL.

Integrations

Graphene has multiple integrations with different frameworks:

integration	Package
Django	graphene-django
SQLAlchemy	graphene-sqlalchemy
Google App Engine	graphene-gae
Peewee	In progress (Tracking Issue)

Also, Graphene is fully compatible with the GraphQL spec, working seamlessly with all GraphQL clients, such as Relay, Apollo and gql.

Installation

For instaling graphene, just run this command in your shell

pip install "graphene>=2.0"

2.0 Upgrade Guide

Please read UPGRADE-v2.0.md to learn how to upgrade.

Examples

Here is one example for you to get started:

class Query(graphene.ObjectType):
    hello = graphene.String(description='A typical hello world')

    def resolve_hello(self, info):
        return 'World'

schema = graphene.Schema(query=Query)

Then Querying graphene.Schema is as simple as:

query = '''
    query SayHello {
      hello
    }
'''
result = schema.execute(query)

If you want to learn even more, you can also check the following examples:

Basic Schema: Starwars example
Relay Schema: Starwars Relay example

Contributing

After cloning this repo, ensure dependencies are installed by running:

pip install -e ".[test]"

After developing, the full test suite can be evaluated by running:

py.test graphene --cov=graphene --benchmark-skip # Use -v -s for verbose mode

You can also run the benchmarks with:

py.test graphene --benchmark-only

Documentation

The documentation is generated using the excellent Sphinx and a custom theme.

The documentation dependencies are installed by running:

cd docs
pip install -r requirements.txt

Then to produce a HTML version of the documentation:

make html

Metadata

Release files for graphene 2.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for graphene 2.1.2
File	Size	Uploaded
graphene-2.1.2.tar.gz	40.4 kB	Jun 14, 2018	Details

Built distribution (wheel)

Table of built distributions (wheels) for graphene 2.1.2
File	Interpreter	ABI	Platform	Reset
graphene-2.1.2-py2.py3-none-any.whl 101.4 kB Jun 14, 2018	Python 2, Python 3	none	any	Details

Total release size: 141.8 kB

Release files / graphene-2.1.2.tar.gz

Download URL	graphene-2.1.2.tar.gz
Size	40.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`98e74c32d0415e5b5362738c1c1cb4b7a4e411b5d3d828abb29ccd3efb378c44`
BLAKE2b-256 checksum How to use checksums	`ede0c1f50d94d6a84cf8c4217b73e656097bbc960a94cd2c913d07158c0c21a2`
Upload date	Jun 14, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / graphene-2.1.2-py2.py3-none-any.whl

Download URL	graphene-2.1.2-py2.py3-none-any.whl
Size	101.4 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`8fd8e6195c56c15b2936e7dee2e156692eba4752ee1978f65e10925eafe8d014`
BLAKE2b-256 checksum How to use checksums	`17c8d326bb2bb207af057d9cd8b986bdc09afa56c54ccf642e0a864e6e9e3970`
Upload date	Jun 14, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No