Build powerful, efficient, and flexible GraphQL APIs with seamless Django integration.
Go to file
Yiğit Y. Er 281da38beb
minor fix on schema.py part
The documentation already suggests importing ObjectType from graphene, graphene.ObjectType is not necessary while defining the Query class.
2022-02-10 15:24:36 +03:00
.github Django v4, python 3.10 support for graphene-django v3 (#1281) 2022-01-07 20:26:07 +00:00
bin Isolated Graphene Django in a new package 2016-09-17 16:31:17 -07:00
docs minor fix on schema.py part 2022-02-10 15:24:36 +03:00
examples Bump django from 3.1.8 to 3.1.14 in /examples/cookbook (#1283) 2021-12-10 12:58:03 +03:00
graphene_django Update requirements to the official graphene 3.0 release (#1290) 2022-01-22 20:04:30 +00: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 WIP: Merge master into v3 (#1086) 2020-12-30 15:37:57 -08:00
README.md Django v4, python 3.10 support for graphene-django v3 (#1281) 2022-01-07 20:26:07 +00:00
README.rst WIP: Merge master into v3 (#1086) 2020-12-30 15:37:57 -08:00
setup.cfg Fix project setup (#1087) 2021-01-02 09:46:00 -08:00
setup.py Update requirements to the official graphene 3.0 release (#1290) 2022-01-22 20:04:30 +00:00
tox.ini Django v4, python 3.10 support for graphene-django v3 (#1281) 2022-01-07 20:26:07 +00: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>=3"

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