graphene-django

Pre-release

This release is a pre-release and may not be stable for production use.

Please read UPGRADE-v1.0.md to learn how to upgrade to Graphene 1.0.

Graphene-Django

Installation

For instaling graphene, just run this command in your shell

pip install "graphene-django>=1.0"

Settings

INSTALLED_APPS = (
    # ...
    '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)

    @graphene.resolve_only_args
    def resolve_users(self):
        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:

Schema with Filtering: Cookbook example
Relay Schema: Starwars Relay example

Contributing

After cloning this repo, ensure dependencies are installed by running:

pip install -e ".[test]"

After developing, the full test suite can be evaluated by running:

py.test graphene_django --cov=graphene_django # Use -v -s for verbose mode

Documentation

The documentation is generated using the excellent Sphinx and a custom theme.

The documentation dependencies are installed by running:

cd docs
pip install -r requirements.txt

Then to produce a HTML version of the documentation:

make html

Release files for graphene-django 2.0.dev2017073101

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for graphene-django 2.0.dev2017073101
File	Size	Uploaded
graphene-django-2.0.dev2017073101.tar.gz	35.5 kB	Aug 1, 2017	Details

Built distribution (wheel)

Table of built distributions (wheels) for graphene-django 2.0.dev2017073101
File	Interpreter	ABI	Platform	Reset
graphene_django-2.0.dev2017073101-py2.py3-none-any.whl 52.3 kB Aug 1, 2017	Python 2, Python 3	none	any	Details

Total release size: 87.8 kB

Release files / graphene-django-2.0.dev2017073101.tar.gz

Download URL	graphene-django-2.0.dev2017073101.tar.gz
Size	35.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`c81a696e703856448de2f96ef3e21c7537baeb738155326eaf73e63f293dd822`
BLAKE2b-256 checksum How to use checksums	`30868e43465f57e1a287568f0bcd47b1f0bfb78eab8de14fc2d3a767b47d1d06`
Upload date	Aug 1, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / graphene_django-2.0.dev2017073101-py2.py3-none-any.whl

Download URL	graphene_django-2.0.dev2017073101-py2.py3-none-any.whl
Size	52.3 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`a96f6be6f112552b7431323fc72eeaec1ae2c527d5046aa01d059bc0a0e94667`
BLAKE2b-256 checksum How to use checksums	`ee1089af4e4d8f4e89e1b3c3ef19868a51ae26af0305f1d5d5c3eebef04e12eb`
Upload date	Aug 1, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No