graphene-django

Pre-release

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

You are in the next unreleased version of Graphene-Django (1.0.dev). Please read UPGRADE-v1.0.md to learn how to upgrade.

Graphene-Django

A Django integration for Graphene.

Installation

For instaling graphene, just run this command in your shell

pip install "graphene-django>=1.0.dev"

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

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:

python setup.py install

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

python setup.py test # Use --pytest-args="-v -s" for verbose mode

Release files for graphene-django 1.0.dev20160922000001

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 1.0.dev20160922000001
File	Size	Uploaded
graphene-django-1.0.dev20160922000001.tar.gz	27.9 kB	Sep 23, 2016	Details

Release files / graphene-django-1.0.dev20160922000001.tar.gz

Download URL	graphene-django-1.0.dev20160922000001.tar.gz
Size	27.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`b795aa3a7592d62f4ca849986c1e08ed812a2c9600c9b01aacccb2310d8cb622`
BLAKE2b-256 checksum How to use checksums	`a02e2ca82f77faf5f1bbf94b45e4ece46edcba4ed84cf11369c00c4d77cc30e7`
Upload date	Sep 23, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No