Build powerful, efficient, and flexible GraphQL APIs with seamless Django integration.
Go to file
Peter Paul Kiefer a4f1a843c3 fix broken links for the v2 branch
v2 brach has broken links to read the docs too

I additionally found a link to the git hub master tree, which should be
changed to main.
2022-02-12 18:37:23 +01:00
.github Replace calls to methods removed in Django v4 (#1275) 2022-02-07 17:16:41 +03:00
bin Isolated Graphene Django in a new package 2016-09-17 16:31:17 -07:00
docs fix broken links for the v2 branch 2022-02-12 18:37:23 +01:00
examples Include tests and examples in source package, but don't install them (#1034) 2020-10-19 17:23:41 +01:00
graphene_django Replace calls to methods removed in Django v4 (#1275) 2022-02-07 17:16:41 +03:00
.coveragerc Improved python syntax and sorts (pep8). Improved Readme 2016-09-17 17:09:56 -07:00
.gitignore Added tox.ini 2019-05-22 01:49:52 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-05-06 13:28:02 +01:00
CONTRIBUTING.md Introduce Black formatting, additional tests 2019-05-02 17:46:35 +01:00
LICENSE add license to repo 2018-05-25 01:28:51 -04:00
Makefile Update flake8 (#688) 2019-06-24 18:55:44 +01:00
MANIFEST.in Include tests and examples in source package, but don't install them (#1034) 2020-10-19 17:23:41 +01:00
pytest.ini Include tests and examples in source package, but don't install them (#1034) 2020-10-19 17:23:41 +01:00
README.md Change build badge from travis to github actions (#1058) 2020-11-07 21:44:37 -08:00
README.rst Change build badge from travis to github actions (#1058) 2020-11-07 21:44:37 -08:00
setup.cfg Bugfix: Correct filter types for DjangoFilterConnectionFields (#682) 2019-07-07 12:11:27 -07:00
setup.py Replace Unidecode package with text_unidecode package #1014 (#1060) 2020-12-22 20:12:22 -08:00
tox.ini Replace calls to methods removed in Django v4 (#1275) 2022-02-07 17:16:41 +03:00

Graphene Logo Graphene-Django

A Django integration for Graphene.

build pypi Anaconda-Server Badge coveralls

💬 Join the community on Slack

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

urlpatterns = [
    # ...
    path('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 query the schema:

query = '''
    query {
      users {
        name,
        lastName
      }
    }
'''
result = schema.execute(query)

To learn more check out the following examples:

GraphQL testing clients

Contributing

See CONTRIBUTING.md

Release Notes