Graphene Django integration
Project description
Please read UPGRADE-v1.0.md to learn how to upgrade to Graphene 1.0.
Graphene-Django 
A Django integration for Graphene.
Installation
For instaling graphene, just run this command in your shell
pip install "graphene-django>=1.0"Settings
INSTALLED_APPS = (
# ...
'graphene_django',
)
GRAPHENE = {
'SCHEMA': 'app.schema.schema' # Where your Graphene schema lives
}Urls
We need to set up a GraphQL endpoint in our Django app, so we can serve the queries.
from django.conf.urls import url
from graphene_django.views import GraphQLView
urlpatterns = [
# ...
url(r'^graphql', GraphQLView.as_view(graphiql=True)),
]Examples
Here is a simple Django model:
from django.db import models
class UserModel(models.Model):
name = models.CharField(max_length=100)
last_name = models.CharField(max_length=100)To create a GraphQL schema for it you simply have to write the following:
from graphene_django import DjangoObjectType
import graphene
class User(DjangoObjectType):
class Meta:
model = UserModel
class Query(graphene.ObjectType):
users = graphene.List(User)
@graphene.resolve_only_args
def resolve_users(self):
return UserModel.objects.all()
schema = graphene.Schema(query=Query)Then you can simply query the schema:
query = '''
query {
users {
name,
lastName
}
}
'''
result = schema.execute(query)To learn more check out the following examples:
Schema with Filtering: Cookbook example
Relay Schema: Starwars Relay example
Contributing
After cloning this repo, ensure dependencies are installed by running:
pip install -e ".[test]"After developing, the full test suite can be evaluated by running:
py.test graphene_django --cov=graphene_django # Use -v -s for verbose modeDocumentation
The documentation is generated using the excellent Sphinx and a custom theme.
The documentation dependencies are installed by running:
cd docs
pip install -r requirements.txtThen to produce a HTML version of the documentation:
make htmlRelease 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-django-2.0.dev2017072601.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 975adf60849d27c678257638e3a0a6c546a9d27acc0a1b93a08f0c6f95624771 |
|
| MD5 | 2709f516c6187009167c358dd6e1aa84 |
|
| BLAKE2b-256 | 4e0a68cf1323ac3d16183c12833f40956d55f95924bcff009157b772d124acaa |
