Skip to main content

Strawberry GraphQL Django extension

Project description

Strawberry GraphQL Django Integration

CI Coverage PyPI Downloads PyPI - Python Version

Documentation | Discord

Strawberry GraphQL Django integration provides powerful tools to build GraphQL APIs with Django. Automatically generate GraphQL types, queries, mutations, and resolvers from your Django models with full type safety.

Installation

pip install strawberry-graphql-django

Features

  • 🍓 Automatic Type Generation - Generate GraphQL types from Django models with full type safety
  • 🔍 Advanced Filtering - Powerful filtering system with lookups (contains, exact, in, etc.)
  • 📄 Pagination - Built-in offset and cursor-based (Relay) pagination
  • 📊 Ordering - Sort results by any field with automatic ordering support
  • 🔐 Authentication & Permissions - Django auth integration with flexible permission system
  • CRUD Mutations - Auto-generated create, update, and delete mutations with validation
  • Query Optimizer - Automatic select_related and prefetch_related to prevent N+1 queries
  • 🐍 Django Integration - Works with Django views (sync and async), forms, and validation
  • 🐛 Debug Toolbar - GraphiQL integration with Django Debug Toolbar for query inspection

Quick Start

# models.py
from django.db import models


class Fruit(models.Model):
    name = models.CharField(max_length=20)
    color = models.ForeignKey("Color", on_delete=models.CASCADE, related_name="fruits")


class Color(models.Model):
    name = models.CharField(max_length=20)
# 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],
)
# urls.py
from django.urls import path
from strawberry.django.views import AsyncGraphQLView
from .schema import schema

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

That's it! You now have a fully functional GraphQL API with:

  • Automatic type inference from Django models
  • Optimized database queries (no N+1 problems)
  • Interactive GraphiQL interface at /graphql/

Visit http://localhost:8000/graphql/ and try this query:

query {
  fruits {
    id
    name
    color {
      name
    }
  }
}

Next Steps

Check out our comprehensive documentation:

Contributing

We welcome contributions! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated 😊

Quick Start:

git clone https://github.com/strawberry-graphql/strawberry-django
cd strawberry-django
pre-commit install

Then run tests with make test or make test-dist for parallel execution.

Community

License

This project is licensed under the MIT License.

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

strawberry_graphql_django-0.86.3-py3-none-any.whl (117.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: strawberry_graphql_django-0.86.3.tar.gz
  • Upload date:
  • Size: 93.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for strawberry_graphql_django-0.86.3.tar.gz
Algorithm Hash digest
SHA256 c38b09c4bfc82292c852f840781daf3e6b2b98da69d791704b513259ba7bb927
MD5 c00d4fe2b27bbea1760a6c51ab30b8a3
BLAKE2b-256 68aafb4055d2f8d0038a4e009b11dcb8bbec12c17c7742035f97af65de5d384a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: strawberry_graphql_django-0.86.3-py3-none-any.whl
  • Upload date:
  • Size: 117.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for strawberry_graphql_django-0.86.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0b3369de7b1e996ffe59ab9a32a02b2f4ddfd4f390c39f65f2ecdabf7a37e594
MD5 a531d4de56caac00c7cbbb799ee78f35
BLAKE2b-256 5b33cd5c343bf36c059696ae997786f520007ad9cc9a60280a58586cd4e1303d

See more details on using hashes here.

Supported by

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