You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Jonathan Kim 692540cc78
Update flake8 (#688)
3 years ago
.github Add stale bot (#661) 3 years ago
bin Isolated Graphene Django in a new package 6 years ago
docs Add `convert_choices_to_enum` option on DjangoObjectType Meta class (#674) 3 years ago
examples Make cookbook example working on django 2 (#680) 3 years ago
graphene_django Update flake8 (#688) 3 years ago
.coveragerc Improved python syntax and sorts (pep8). Improved Readme 6 years ago
.gitignore Added tox.ini 3 years ago
.travis.yml Update travis and tox (#667) 3 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 3 years ago
CONTRIBUTING.md Introduce Black formatting, additional tests 3 years ago
LICENSE add license to repo 4 years ago
MANIFEST.in Add static files to MANIFEST.in 3 years ago
Makefile Update flake8 (#688) 3 years ago
README.md Rebuild documentation 3 years ago
README.rst Rebuild documentation 3 years ago
django_test_settings.py added ModelSerializer tests 5 years ago
pytest.ini create pytest.ini to contain DJANGO_SETTINGS_MODULE 6 years ago
setup.cfg Update flake8 (#688) 3 years ago
setup.py Update flake8 (#688) 3 years ago
tox.ini Update flake8 (#688) 3 years ago

README.md

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.

Documentation

Visit the documentation to get started!

Quickstart

For installing graphene, just run this command in your shell

pip install "graphene-django>=2.0"

Settings

INSTALLED_APPS = (
    # ...
    'django.contrib.staticfiles', # Required for GraphiQL
    '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)

    def resolve_users(self, info):
        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

See CONTRIBUTING.md