Strawberry GraphQL Django extension
Project description
Strawberry GraphQL Django extension
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
Full documentation is available under docs github folder.
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
- Unit test integration
Basic Usage
# models.py
from django.db import models
class Fruit(models.Model):
name = models.CharField(max_length=20)
color = models.ForeignKey('Color', blank=True, null=True,
related_name='fruits', on_delete=models.CASCADE)
class Color(models.Model):
name = models.CharField(max_length=20)
# types.py
import strawberry
from strawberry import auto
from typing import List
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 typing import List
from .types import Fruit
@strawberry.type
class Query:
fruits: List[Fruit] = strawberry.django.field()
schema = strawberry.Schema(query=Query)
Code above generates following schema.
type Fruit {
id: ID!
name: String!
color: Color
}
type Color {
id: ID!
name: String!
fruits: [Fruit!]
}
type Query {
fruits: [Fruit!]!
}
# 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)),
]
See complete Django project from github repository folder examples/django.
Autocompletion with editors
Some editors like VSCode may not be able to resolve symbols and types without explicit strawberry.django import. Adding following line to code fixes that problem.
import strawberry.django
Running unit tests
poetry install
poetry run pytest
Pre commit hooks
We have a configuration for pre-commit, to add the hook run the following command:
pre-commit install
Contributing
We are happy to get pull requests and feedback from you.
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
Built Distribution
File details
Details for the file strawberry-graphql-django-0.3.1.tar.gz.
File metadata
- Download URL: strawberry-graphql-django-0.3.1.tar.gz
- Upload date:
- Size: 15.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.10.5 Linux/5.18.0-2-amd64
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d66dd816211b5e4a60920a9e0697c1df63d8e14edf02ab04e1c1b696d19eda33 |
|
| MD5 | b35c32d97d20f7cc6e3b95316a87ca89 |
|
| BLAKE2b-256 | 2f113428d7c8ad2d4c93179a8e992cf507ee189fd52149442276aad56bcb86c3 |
File details
Details for the file strawberry_graphql_django-0.3.1-py3-none-any.whl.
File metadata
- Download URL: strawberry_graphql_django-0.3.1-py3-none-any.whl
- Upload date:
- Size: 20.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.10.5 Linux/5.18.0-2-amd64
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f2c55da70d02cb67ee225995798a4b5f26b802228a4fa8fb931eb55e50c775dd |
|
| MD5 | 6edc7bc168bebbbe47d94b638ce7fd4d |
|
| BLAKE2b-256 | bc4d683a467d50950902c4e84634bf73e52d41589b711a22d21f70bec423465e |
