Graphene: Python DSL for GraphQL
Project description
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
What is supported in this Python version? Everything: Interfaces, ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition to queries, mutations and subscriptions.
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.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:
Basic Schema: Starwars example
Relay Schema: Starwars Relay example
Django model mapping: Starwars Django example
Contributing
After cloning this repo, ensure dependencies are installed by running:
python setup.py installAfter developing, the full test suite can be evaluated by running:
python setup.py test # Use --pytest-args="-v -s" for verbose modeRelease 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.
