Build powerful, efficient, and flexible GraphQL APIs with seamless Django integration.
Go to file
2017-02-09 18:18:50 +02:00
bin Isolated Graphene Django in a new package 2016-09-17 16:31:17 -07:00
docs Add Adding login required section to authorization 2017-02-09 18:18:50 +02:00
examples Fix broken link in cookbook schema 2016-12-03 11:08:25 -05:00
graphene_django Merge pull request #82 from gamingexperience/fix/node-filtering 2017-01-14 18:35:52 -08:00
.coveragerc Improved python syntax and sorts (pep8). Improved Readme 2016-09-17 17:09:56 -07:00
.gitignore Moved django-graphql-view and django-graphiql into graphene-django 😎 2016-09-19 22:04:23 -07:00
.travis.yml Fixed travis build 2016-11-23 02:20:32 -08:00
django_test_settings.py Moved django-graphql-view and django-graphiql into graphene-django 😎 2016-09-19 22:04:23 -07:00
MANIFEST.in Include templates in package. Updated dev version 2016-09-19 23:04:07 -07:00
pytest.ini create pytest.ini to contain DJANGO_SETTINGS_MODULE 2016-11-16 09:56:55 -08:00
README.md Add docs about how to build docs, and add sphinx as docs requirement. 2016-11-12 19:47:44 +01:00
README.rst Add docs about how to build docs, and add sphinx as docs requirement. 2016-11-12 19:47:44 +01:00
setup.cfg create pytest.ini to contain DJANGO_SETTINGS_MODULE 2016-11-16 09:56:55 -08:00
setup.py Updated version to 1.2.1 2016-12-16 00:27:33 -08:00

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


Graphene Logo Graphene-Django Build Status PyPI version Coverage Status

A Django integration for Graphene.

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:

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

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