Graphene Django integration
Project description
Please read UPGRADE-v2.0.md to learn how to upgrade to Graphene 2.0.
Graphene-Django

A Django integration for Graphene.
Documentation
Quickstart
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:
- Schema with Filtering: Cookbook example
- Relay Schema: Starwars Relay example
Contributing
See CONTRIBUTING.md.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
graphene-django-2.15.0.tar.gz
(67.1 kB
view hashes)
Built Distribution
Close
Hashes for graphene_django-2.15.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02671d195f0c09c8649acff2a8f4ad4f297d0f7d98ea6e6cdf034b81bab92880 |
|
MD5 | cae1ffa59c65b3deadaf31746b49207e |
|
BLAKE2-256 | ebaac40236831391abc1f331b79bdb7cc72ce17f63662fc9e261264852e8fe52 |