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.
 
 
 
 
Aaron Forsander f6ec0689c1
Fix documentation references: op_name -> operation_name (#1312)
6 months ago
.github Django v4, python 3.10 support for graphene-django v3 (#1281) 7 months ago
bin Isolated Graphene Django in a new package 6 years ago
docs Fix documentation references: op_name -> operation_name (#1312) 6 months ago
examples Bump django from 3.1.8 to 3.1.14 in /examples/cookbook (#1283) 8 months ago
graphene_django Fix documentation references: op_name -> operation_name (#1312) 6 months ago
.coveragerc Improved python syntax and sorts (pep8). Improved Readme 6 years ago
.gitignore Added tox.ini 3 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 3 years ago
CONTRIBUTING.md Introduce Black formatting, additional tests 3 years ago
LICENSE add license to repo 4 years ago
MANIFEST.in WIP: Merge master into v3 (#1086) 2 years ago
Makefile Update flake8 (#688) 3 years ago
README.md Django v4, python 3.10 support for graphene-django v3 (#1281) 7 months ago
README.rst WIP: Merge master into v3 (#1086) 2 years ago
setup.cfg Fix project setup (#1087) 2 years ago
setup.py Update requirements to the official graphene 3.0 release (#1290) 7 months ago
tox.ini Django v4, python 3.10 support for graphene-django v3 (#1281) 7 months ago

README.md

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