Skip to content

graphql-python/graphene-django

Folders and files

NameName
Last commit message
Last commit date

Latest commit

bad8e13 · Jun 7, 2019
Sep 17, 2016
Jun 6, 2019
May 20, 2019
May 31, 2019
Sep 18, 2016
Feb 14, 2017
May 2, 2019
May 6, 2019
May 2, 2019
May 25, 2018
Mar 25, 2019
May 2, 2019
May 7, 2019
May 7, 2019
Nov 13, 2017
Nov 16, 2016
Aug 31, 2017
May 2, 2019

Repository files navigation

Please read UPGRADE-v2.0.md to learn how to upgrade to Graphene 2.0.


Graphene Logo Graphene-Django Build Status PyPI version Coverage Status

A Django integration for Graphene.

Documentation

Visit the documentation to get started!

Quickstart

For installing graphene, just run this command in your shell

pip install "graphene-django>=2.0"

Settings

INSTALLED_APPS = (
    # ...
    'django.contrib.staticfiles', # Required for GraphiQL
    '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)

    def resolve_users(self, info):
        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:

Contributing

See CONTRIBUTING.md