GraphQL framework for Python
Go to file
2015-10-29 23:48:13 -07:00
bin Added documentation converter using panic 2015-10-29 23:48:13 -07:00
examples Removed unnecessary meta in starters example 2015-10-28 01:51:35 -07:00
graphene Improved testing coverage. Removed unused logic 2015-10-29 23:27:41 -07:00
tests Improved testing coverage. Removed unused logic 2015-10-29 23:27:41 -07:00
.gitignore Moved all the examples from tests to examples 2015-10-27 23:56:24 -07:00
.travis.yml Added caching to travis tests 2015-10-28 01:34:51 -07:00
LICENSE First working version of Graphene 😃 2015-09-24 02:11:50 -07:00
README.md Improved README 2015-10-27 23:57:25 -07:00
README.rst Added documentation converter using panic 2015-10-29 23:48:13 -07:00
setup.cfg First working version of Graphene 😃 2015-09-24 02:11:50 -07:00
setup.py Updated version 2015-10-23 01:52:31 -07:00
tox.ini Fixed Python3 errors 2015-10-26 01:59:38 -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: It maps the models/fields to internal GraphQL objects without effort.
  • Relay: Graphene has builtin support for Relay
  • Django: Automatic Django model mapping to Graphene Types. See an example Django implementation

Installation

For instaling graphene, just run this command in your shell

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

Examples

Here is one example for get you started:

class Query(graphene.ObjectType):
    hello = graphene.StringField(description='A typical hello world')
    ping = graphene.StringField(description='Ping someone',
                                to=graphene.Argument(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