GraphQL framework for Python
Go to file
2015-11-06 01:13:28 -08:00
bin Improved syntax. Added autolinter. Added automatic flake8 checker in tests. Fixed #17 2015-10-31 14:02:22 -07:00
examples Improved django example 2015-11-02 19:36:49 -08:00
graphene First types implementation 2015-11-06 01:13:28 -08:00
tests Changed from field_name to attname for field attribute name 2015-11-05 00:14:03 -08:00
.gitignore Moved all the examples from tests to examples 2015-10-27 23:56:24 -07:00
.travis.yml Improved syntax. Added autolinter. Added automatic flake8 checker in tests. Fixed #17 2015-10-31 14:02:22 -07:00
LICENSE First working version of Graphene 😃 2015-09-24 02:11:50 -07:00
README.md Update README.rst 2015-10-30 13:47:34 -07:00
README.rst Update README.rst 2015-10-30 13:47:34 -07:00
setup.cfg First types implementation 2015-11-06 01:13:28 -08:00
setup.py First types implementation 2015-11-06 01:13:28 -08:00
tox.ini Improved syntax. Added autolinter. Added automatic flake8 checker in tests. Fixed #17 2015-10-31 14:02:22 -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

But, what is supported in this Python version? Everything: Interfaces, ObjectTypes, Mutations and Relay (Nodes, Connections and Mutations).

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