Skip to main content

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 = (
    # ...
    '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.

Metadata

Release files for graphene-neo4j 2.2.3.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for graphene-neo4j 2.2.3.9
File Size Uploaded
graphene-neo4j-2.2.3.9.tar.gz 52.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for graphene-neo4j 2.2.3.9
File Interpreter ABI Platform
graphene_neo4j-2.2.3.9-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 126.4 kB

Release files / graphene-neo4j-2.2.3.9.tar.gz

Download URL graphene-neo4j-2.2.3.9.tar.gz
Size 52.6 kB
Tags Source
SHA-256 checksum
How to use checksums
de77e37427a83827b8fd538a5c893c624d292187a1df2f03e45bb6b26dd17656
BLAKE2b-256 checksum
How to use checksums
5c70d0a9904e0050d763fb7c8026e6533a781ba5e50297b54024fcee40dd0805
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

Release files / graphene_neo4j-2.2.3.9-py2.py3-none-any.whl

Download URL graphene_neo4j-2.2.3.9-py2.py3-none-any.whl
Size 73.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
8792912f85f03d6ab446011fe066d3aa929a6429f5131af1820a2a63833fdd99
BLAKE2b-256 checksum
How to use checksums
e453452ac4633c2eed25a6cc4ce2b116843d52ace941c2e2789a02cee760451c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

Release history Release notifications | RSS feed

This release

2.2.3.9 This release

2 release files

2.2.3

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page