We are looking for contributors! Please check the ROADMAP to see how you can help ❤️

---

Graphene

Supporting Graphene Python

Graphene is an MIT-licensed open source project. It's an independent project with its ongoing development made possible entirely thanks to the support by these awesome backers. If you'd like to join them, please consider:

• Become a backer or sponsor on Patreon.
• One-time donation via PayPal.

Platinum via Patreon

Gold via Patreon

Silver via Patreon

---

Introduction

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

Documentation

Documentation and links to additional resources are available at https://docs.graphene-python.org/en/latest/

Contributing

See Contributing