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.11.0.tar.gz (57.6 kB view details)

Uploaded Source

Built Distribution

strawberry_graphql_django-0.11.0-py3-none-any.whl (70.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for strawberry_graphql_django-0.11.0.tar.gz
Algorithm Hash digest
SHA256 a36bf308f3145e58061a312b3a919bbacd0897267032b0ff4aae90be44e5af22
MD5 3b0ad26dfe01520502680b5f4e8383e0
BLAKE2b-256 089d5a1a7a34a522ff07fef80bd7f0c08cbd4ba4994722172a60aff6008e3403

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for strawberry_graphql_django-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f569dc066becbed46f537fd660bbd98d34a5477e9a11d973d59a881e605afd41
MD5 196b06a025f8a753ac65534d986acd7e
BLAKE2b-256 a569f765485fb00e0dda1dd38709dfd4196fff5e8468c07e5199d1d4af264b99

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