Graphene Django integration
Python HTML Shell
Latest commit 5d6c7f2 Jan 14, 2017 @syrusakbary syrusakbary committed on GitHub Merge pull request #60 from timothyjlaurent/#59-fix-test-django-settings
#59 fix test django settings

Please read to learn how to upgrade to Graphene 1.0.

Graphene Logo Graphene-Django Build Status PyPI version Coverage Status

A Django integration for Graphene.


For instaling graphene, just run this command in your shell

pip install "graphene-django>=1.0"


    # ...

    'SCHEMA': 'app.schema.schema' # Where your Graphene schema lives


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)),


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)

    def resolve_users(self):
        return UserModel.objects.all()

schema = graphene.Schema(query=Query)

Then you can simply query the schema:

query = '''
    query {
      users {
result = schema.execute(query)

To learn more check out the following examples:


After cloning this repo, ensure dependencies are installed by running:

python install

After developing, the full test suite can be evaluated by running:

python test # Use --pytest-args="-v -s" for verbose mode


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.txt

Then to produce a HTML version of the documentation:

make html