You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jonathan Kim 88f6ec458c v3.0.0b4 2 years ago
.github Merge branch 'master' into v3 2 years ago
bin Isolated Graphene Django in a new package 6 years ago
docs Warn if `fields` or `exclude` are not defined on `DjangoObjectType` (#981) 2 years ago
examples Warn if `fields` or `exclude` are not defined on `DjangoObjectType` (#981) 2 years ago
graphene_django v3.0.0b4 2 years ago
.coveragerc Improved python syntax and sorts (pep8). Improved Readme 6 years ago
.gitignore Added tox.ini 3 years ago Create 3 years ago Introduce Black formatting, additional tests 3 years ago
LICENSE add license to repo 4 years ago Add static files to 3 years ago
Makefile Update flake8 (#688) 3 years ago graphql 3.0 and graphene 3.0 final rebase (#951) 2 years ago
README.rst graphql 3.0 and graphene 3.0 final rebase (#951) 2 years ago added ModelSerializer tests 5 years ago
setup.cfg Make tests order independent (v3) (#940) 2 years ago Move to_const function from Graphene into Graphene-Django (#992) (#996) 2 years ago
tox.ini Merge branch 'master' into v3 2 years ago

Graphene Logo Graphene-Django

A Django integration for Graphene.

travis pypi Anaconda-Server Badge coveralls

💬 Join the community on Slack


Visit the documentation to get started!


For installing graphene, just run this command in your shell

pip install "graphene-django>=3"


    # ...
    'django.contrib.staticfiles', # Required for GraphiQL

    '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.urls import path
from graphene_django.views import GraphQLView

urlpatterns = [
    # ...
    path('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, info):
        return UserModel.objects.all()

schema = graphene.Schema(query=Query)

Then you can query the schema:

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

To learn more check out the following examples:



Release Notes