Skip to main content

Strawberry GraphQL Django extension

Project description

Strawberry GraphQL Django integration

CI Coverage PyPI Downloads PyPI - Python Version

Docs | Discord

This package provides powerful tools to generate GraphQL types, queries, mutations and resolvers from Django models.

Installing strawberry-graphql-django package from the python package repository.

pip install strawberry-graphql-django

Supported Features

  • GraphQL type generation from models
  • Filtering, pagination and ordering
  • Basic create, retrieve, update and delete (CRUD) types and mutations
  • Basic Django auth support, current user query, login and logout mutations
  • Django sync and async views
  • Permission extension using django's permissioning system
  • Relay support with automatic resolvers generation
  • Query optimization to improve performance and avoid common pitfalls (e.g n+1)
  • Debug Toolbar integration with graphiql to display metrics like SQL queries
  • Unit test integration

Basic Usage

# models.py

from django.db import models

class Fruit(models.Model):
    """A tasty treat"""
    name = models.CharField(
        max_length=20,
    )
    color = models.ForeignKey(
        "Color",
        on_delete=models.CASCADE,
        related_name="fruits",
        blank=True,
        null=True,
    )

class Color(models.Model):
    name = models.CharField(
        max_length=20,
        help_text="field description",
    )
# types.py

import strawberry
import strawberry.django
from strawberry import auto

from . import models

@strawberry.django.type(models.Fruit)
class Fruit:
    id: auto
    name: auto
    color: 'Color'

@strawberry.django.type(models.Color)
class Color:
    id: auto
    name: auto
    fruits: list[Fruit]
# schema.py

import strawberry
from strawberry_django.optimizer import DjangoOptimizerExtension

from .types import Fruit

@strawberry.type
class Query:
    fruits: list[Fruit] = strawberry.django.field()

schema = strawberry.Schema(
    query=Query,
    extensions=[
        DjangoOptimizerExtension,  # not required, but highly recommended
    ],
)
# urls.py

from django.urls import include, path
from strawberry.django.views import AsyncGraphQLView

from .schema import schema

urlpatterns = [
    path('graphql', AsyncGraphQLView.as_view(schema=schema)),
]

Code above generates following schema.

"""
A tasty treat
"""
type Fruit {
  id: ID!
  name: String!
  color: Color
}

type Color {
  id: ID!
  """
  field description
  """
  name: String!
  fruits: [Fruit!]
}

type Query {
  fruits: [Fruit!]!
}

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

strawberry_graphql_django-0.10.0.tar.gz (56.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file strawberry_graphql_django-0.10.0.tar.gz.

File metadata

  • Download URL: strawberry_graphql_django-0.10.0.tar.gz
  • Upload date:
  • Size: 56.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Linux/6.3.0-1-amd64

File hashes

Hashes for strawberry_graphql_django-0.10.0.tar.gz
Algorithm Hash digest
SHA256 bf7c337bb9388fb062b17346f589d791c89d8b10bdff209b9f973c1eecb2de2a
MD5 13c74d6fd84fb4dd6d49476858915ee7
BLAKE2b-256 0b679074f8910f6f6341617e5c82cbc53396d10a5c0f5a354e9bbb6db2460b32

See more details on using hashes here.

File details

Details for the file strawberry_graphql_django-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for strawberry_graphql_django-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a2a2d4ffdcfec0928286fdc793135e387755a842648475c85039260e6d75a601
MD5 ce1d67d4917c46cd8af9d8fe2fd21907
BLAKE2b-256 c1994dcff169352932f1e35db9442c9f789247685ee52fa8e2ab82d1754ddb53

See more details on using hashes here.

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