Skip to main content

Graphene Django integration

Project description

Please read UPGRADE-v2.0.md to learn how to upgrade to Graphene 2.0.


Graphene Logo Graphene-Django Build Status PyPI version Coverage Status

A Django integration for Graphene.

Installation

For installing graphene, just run this command in your shell

pip install "graphene-django>=2.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

Project details


Release history Release notifications

This version
History Node

2.1.0

History Node

2.1rc1

History Node

2.1rc0

History Node

2.0.0

History Node

2.0.dev2017083101

History Node

2.0.dev2017073101

History Node

2.0.dev2017072601

History Node

2.0.dev2017072501

History Node

1.3

History Node

1.2.1

History Node

1.2.0

History Node

1.1.0

History Node

1.0

History Node

1.0.dev20160922000001

History Node

1.0.dev20160920000001

History Node

1.0.dev20160919000004

History Node

1.0.dev20160919000003

History Node

1.0.dev20160919000002

History Node

1.0.dev20160919000001

History Node

1.0.dev20160917000001

History Node

1.0.dev20160910000001

History Node

1.0.dev20160909000001

History Node

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
graphene_django-2.1.0-py2.py3-none-any.whl (57.8 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jul 20, 2018
graphene-django-2.1.0.tar.gz (41.9 kB) Copy SHA256 hash SHA256 Source None Jul 20, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page