Graphene
![Coverage Status](https://camo.githubusercontent.com/d285a09e6f29baaec1497437dbd8e58798aadedb4de1390fb8209763c7dc31ad/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6772617068716c2d707974686f6e2f6772617068656e652f62616467652e7376673f6272616e63683d6d617374657226736572766963653d676974687562)
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]
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
- SQLAlchemy model mapping: Flask SQLAlchemy example
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