GraphQL Framework for Python
Project description
You are in the next unreleased version of Graphene (1.0.dev). Please read UPGRADE-v1.0.md to learn how to upgrade.
Graphene
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>=1.0.dev
# In case of need Django model support
pip install graphene-django>=1.0.dev
# Or in case of need SQLAlchemy support
pip install graphene-sqlalchemy>=1.0.dev
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:
Basic Schema: Starwars example
Relay Schema: Starwars Relay 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
Project details
Release 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.
Source Distribution
Hashes for graphene-1.0.dev20160909055438.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c4c2a3d2eb2d4d0121efa05eaa7f644150ee8c6c286328d325fa251f44de543 |
|
MD5 | c043a910331c08c64fb61f56111111be |
|
BLAKE2b-256 | ee50160cb62c0006662ab5a0892ba46cd65dcdc0158c3b83bac9e0e528c1530c |