Skip to main content

GraphQL Framework for Python

Project description

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


Graphene Logo Graphene Build Status PyPI version Coverage Status

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:

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

Project details


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

graphene-2.0.dev20170802065539.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

graphene-2.0.dev20170802065539-py2.py3-none-any.whl (102.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file graphene-2.0.dev20170802065539.tar.gz.

File metadata

File hashes

Hashes for graphene-2.0.dev20170802065539.tar.gz
Algorithm Hash digest
SHA256 5166ee46bc101554b506fb7429aea367dcf7258faea1442fad84bd66a4db3056
MD5 2bd205c8c2e889d50a3a174bf6258ef2
BLAKE2b-256 ed537e486f3384d4462f0fade621631da3c531e93c48d1c97e945cf1cfccfea4

See more details on using hashes here.

Provenance

File details

Details for the file graphene-2.0.dev20170802065539-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for graphene-2.0.dev20170802065539-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7c210517eefb79827d92b94e096de627b7364f9cde8c5cfdda50bc2dd30e87fa
MD5 95b99372d43dd60b4e7627b8981a24d2
BLAKE2b-256 6d11a705bb809ae281c1c6908a5edb75cd345e3c9f12a5c567a54b8d912fdde8

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page