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.

Documentation

Visit the documentation to get started!

Quickstart

For installing graphene, just run this command in your shell

pip install "graphene-django>=3"

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

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-3.0.0b5.tar.gz (61.9 kB view details)

Uploaded Source

Built Distribution

graphene_django-3.0.0b5-py2.py3-none-any.whl (77.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file graphene-django-3.0.0b5.tar.gz.

File metadata

  • Download URL: graphene-django-3.0.0b5.tar.gz
  • Upload date:
  • Size: 61.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.8

File hashes

Hashes for graphene-django-3.0.0b5.tar.gz
Algorithm Hash digest
SHA256 d0769396871c01e5c08a8987b98ad6e18f8d2ca2c26b66a1b6bef75668e27826
MD5 65ca1d94836213ab885fb12545243080
BLAKE2b-256 46a22a8211a5715278375e474189600d2aad3302087e2c0d88074c304df7526a

See more details on using hashes here.

Provenance

File details

Details for the file graphene_django-3.0.0b5-py2.py3-none-any.whl.

File metadata

  • Download URL: graphene_django-3.0.0b5-py2.py3-none-any.whl
  • Upload date:
  • Size: 77.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.8

File hashes

Hashes for graphene_django-3.0.0b5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ff46e4fbf7d4fa4c61068ac73011561c8858d36fd79dc768a42c4b82d7ced4bd
MD5 63aab0403f477ff3cf69c886e6d7ca15
BLAKE2b-256 21495e4392d0cf54ce54ebf88b1c572f209ac3de15ae5de2a88fd66aa8919dde

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page