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
Data agnostic: Graphene supports any kind of data source: SQL (Django, SQLAlchemy), NoSQL, custom Python objects, etc. We believe that by providing a complete API you could plug Graphene anywhere your data lives and make your data available through GraphQL.
Integrations
Graphene has multiple integrations with different frameworks:
integration |
Package |
---|---|
Django |
|
SQLAlchemy |
|
Google App Engine |
|
Peewee |
In progress (Tracking Issue) |
Installation
For instaling graphene, just run this command in your shell
pip install "graphene>=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')
def resolve_hello(self, args, context, info):
return 'World'
schema = graphene.Schema(query=Query)
Then Querying graphene.Schema is as simple as:
query = '''
query SayHello {
hello
}
'''
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.dev20160920070441.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e015b2da811e2ecf5ee94a7e5ce6a6b9e658519358753ba8ca169c5ea0b2ec7 |
|
MD5 | 3234c329ff55249eab12aaf0e946ba18 |
|
BLAKE2b-256 | 034840455ca76b8f1d8bad2c25ecad5ed7a0101b77374adc15914958ff4d55ea |