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
Built Distribution
Hashes for graphene-django-2.0.dev2017073101.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c81a696e703856448de2f96ef3e21c7537baeb738155326eaf73e63f293dd822 |
|
| MD5 | 2404d5da51f744cd01adb2aefb0987c6 |
|
| BLAKE2b-256 | 30868e43465f57e1a287568f0bcd47b1f0bfb78eab8de14fc2d3a767b47d1d06 |
Hashes for graphene_django-2.0.dev2017073101-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a96f6be6f112552b7431323fc72eeaec1ae2c527d5046aa01d059bc0a0e94667 |
|
| MD5 | 8ec48869fcfedda7ac0662963e30284e |
|
| BLAKE2b-256 | ee1089af4e4d8f4e89e1b3c3ef19868a51ae26af0305f1d5d5c3eebef04e12eb |
