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_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
import strawberry_django
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.50.0.tar.gz (75.9 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for strawberry_graphql_django-0.50.0.tar.gz
Algorithm Hash digest
SHA256 d17d104c72f63061146d2c03ad52802f58947ac53a8e3495d0a59c66aaa8d547
MD5 cba08bcec8bd4f09ac93f84e81491405
BLAKE2b-256 5aae0eb2f3f1d6636bff7566c684f4407e18b41d49e847f6da38d165b6d8b19b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for strawberry_graphql_django-0.50.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0487d81c5239bc9cc94d485d9963efb23061ff70ed9080ca931077e94e5ad92a
MD5 f858308b55c0470051a65e6d9d4d5d9a
BLAKE2b-256 85d5d857b34c129f7c691fc961681d793383ae81858a7566eee8772c0e602ceb

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