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.1.3.tar.gz (33.1 kB view details)

Uploaded Source

Built Distribution

graphene-2.1.3-py2.py3-none-any.whl (95.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file graphene-2.1.3.tar.gz.

File metadata

  • Download URL: graphene-2.1.3.tar.gz
  • Upload date:
  • Size: 33.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for graphene-2.1.3.tar.gz
Algorithm Hash digest
SHA256 b8ec446d17fa68721636eaad3d6adc1a378cb6323e219814c8f98c9928fc9642
MD5 e93c0b3be2503c088dddcb25350d2a59
BLAKE2b-256 add0c3eb1819a9349e9ce5cb3b906a33ea59ffa2666e08a940f7551506478713

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for graphene-2.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 faa26573b598b22ffd274e2fd7a4c52efa405dcca96e01a62239482246248aa3
MD5 387803bbd48c11e5a21cd3b21ad14ccf
BLAKE2b-256 a67573bec3147071034ba73fad9aa2a8f4a41910a93b2cba1bc579420752aa3b

See more details on using hashes here.

Supported by

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