GraphQL framework for Python
Go to file
2016-08-16 11:21:31 +01:00
bin Improved PEP8 syntax and order imports 2016-01-02 21:19:15 +01:00
examples Fixed PEP8 errors 2016-08-14 16:58:32 -07:00
graphene Added breaking test to demonstrate wanted subclassing feature. 2016-08-16 11:21:31 +01:00
graphene-django Added more info to the connections 2016-08-16 00:33:43 -07:00
graphene-sqlalchemy Updated subpackages dependency 2016-08-16 00:02:16 -07:00
.coveragerc Improved relay requirement, removed Django/SQLAlchemy dependency in main package 2016-06-14 23:59:37 -07:00
.editorconfig Adding .editorconfig to help enforce whitespace rules 2015-12-05 09:02:15 +00:00
.gitignore Fixed travis 2016-08-06 19:28:09 -07:00
.travis.yml Improved travis tests 2016-08-06 19:45:11 -07:00
LICENSE First working version of Graphene 😃 2015-09-24 02:11:50 -07:00
MANIFEST.in Exclude tests directories in graphene package 2016-05-12 00:12:00 -07:00
README.md Added UpgradeGuide 2016-06-10 01:37:08 -07:00
README.rst Updated main documentation mentioning SQLAlchemy support 2016-01-23 15:00:05 -08:00
setup.cfg Fixed tests and flake errors 2016-08-06 19:42:06 -07:00
setup.py Improved system for getting graphene package version 2016-08-14 17:47:52 -07:00
tox.ini Improved relay requirement, removed Django/SQLAlchemy dependency in main package 2016-06-14 23:59:37 -07:00
UPGRADE-v1.0.md Updated UPGRADE guide 2016-08-14 15:45:41 -07:00

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
  • Django: Automatic Django model mapping to Graphene Types. Check a fully working Django implementation

Graphene also supports SQLAlchemy!

What is supported in this Python version? Everything: Interfaces, ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition to queries, mutations and subscriptions.

NEW!: Try graphene online

Installation

For instaling graphene, just run this command in your shell

pip install graphene
# In case of need Django model support
pip install graphene[django]
# Or in case of need SQLAlchemy support
pip install graphene[sqlalchemy]

1.0 Upgrade Guide

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

Examples

Here is one example for get you started:

class Query(graphene.ObjectType):
    hello = graphene.String(description='A typical hello world')
    ping = graphene.String(description='Ping someone',
                           to=graphene.String())

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

    def resolve_ping(self, args, info):
        return 'Pinging {}'.format(args.get('to'))

schema = graphene.Schema(query=Query)

Then Querying graphene.Schema is as simple as:

query = '''
    query SayHello {
      hello
      ping(to:"peter")
    }
'''
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:

python setup.py install

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

python setup.py test # Use --pytest-args="-v -s" for verbose mode