Strawberry GraphQL Django extension
Project description
Strawberry GraphQL Django extension
This package provides simple and 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.django 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.
Running unit tests
poetry install
poetry run pytest
Contributing
We are happy to get pull requests and feedback from you.
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
Built Distribution
Close
Hashes for strawberry-graphql-django-0.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 546c61a721588881e089c07384c016fc46d2cb2b9c9bee2fbd7baeed1289d8ca |
|
MD5 | b52fe14ac8f0bd4ff3631c08fa284705 |
|
BLAKE2b-256 | 4d0431d9e8716da1279cd67718b9b230db0e7163ece924bec85a4aee68e06951 |
Close
Hashes for strawberry_graphql_django-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01d345f94dd99bcb7bc7d8732108fa12009303f11d4bb294cc36c49593ba9473 |
|
MD5 | 84f34e92213f94b6096679eb4eca1ac3 |
|
BLAKE2b-256 | 4153df9744108637282443ab25a415581adbdf8572bad3ff24c6e4324ce15b56 |