Build powerful, efficient, and flexible GraphQL APIs with seamless Django integration.
Go to file
Syrus Akbary 9cac83b168 Merge pull request #243 from jonatasbaldin/jonatas/fix-filtering-documentation
Fix lookup parameter on filtering documentation
2017-08-29 22:33:35 -07:00
bin Isolated Graphene Django in a new package 2016-09-17 16:31:17 -07:00
docs Merge pull request #243 from jonatasbaldin/jonatas/fix-filtering-documentation 2017-08-29 22:33:35 -07:00
examples Fixed examples 2017-07-31 22:42:22 -07:00
graphene_django Added support for wheel package 2017-07-31 22:46:27 -07:00
.coveragerc Improved python syntax and sorts (pep8). Improved Readme 2016-09-17 17:09:56 -07:00
.gitignore Add Vim.gitignore to .gitignore 2017-02-14 20:22:51 +02:00
.travis.yml Generate a universal wheel in addition to the source distribution 2017-08-07 22:25:22 +01: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 Update README.md 2017-04-11 09:10:01 -07:00
README.rst Update README.rst 2017-04-11 09:09:08 -07:00
setup.cfg Merge pull request #229 from graphql-python/2.0 2017-08-27 13:28:08 -07:00
setup.py Added support for wheel package 2017-07-31 22:46:27 -07: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:

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