Strawberry GraphQL

Python GraphQL library based on dataclasses

Installation ( Quick Start )

The quick start method provides a server and CLI to get going quickly. Install with:

pip install "strawberry-graphql[debug-server]"

Getting Started

Create a file called app.py with the following code:

import strawberry


@strawberry.type
class User:
    name: str
    age: int


@strawberry.type
class Query:
    @strawberry.field
    def user(self) -> User:
        return User(name="Patrick", age=100)


schema = strawberry.Schema(query=Query)

This will create a GraphQL schema defining a User type and a single query field user that will return a hardcoded user.

To run the debug server run the following command:

strawberry server app

Open the debug server by clicking on the following link: http://0.0.0.0:8000/graphql

This will open GraphiQL where you can test the API.

Type-checking

Strawberry comes with a mypy plugin that enables statically type-checking your GraphQL schema. To enable it, add the following lines to your mypy.ini configuration:

[mypy]
plugins = strawberry.ext.mypy_plugin

Django Integration

A Django view is provided for adding a GraphQL endpoint to your application.

Add the app to your INSTALLED_APPS.

INSTALLED_APPS = [
    ...,  # your other apps
    "strawberry.django",
]

Add the view to your urls.py file.

from strawberry.django.views import GraphQLView
from .schema import schema

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

WebSockets

To support graphql Subscriptions over WebSockets you need to provide a WebSocket enabled server. The debug server can be made to support WebSockets with these commands:

pip install 'strawberry-graphql[debug-server]'
pip install 'uvicorn[standard]'

Examples

Contributing

We use poetry to manage dependencies, to get started follow these steps:

git clone https://github.com/strawberry-graphql/strawberry
cd strawberry
poetry install --with integrations
poetry run pytest

For all further detail, check out the Contributing Page

Pre commit

We have a configuration for pre-commit, to add the hook run the following command:

pre-commit install

Licensing

The code in this project is licensed under MIT license. See LICENSE for more information.

Recent Activity

Metadata

Release files for strawberry-graphql 0.223.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for strawberry-graphql 0.223.0
File	Size	Uploaded
strawberry_graphql-0.223.0.tar.gz	197.5 kB	Mar 29, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for strawberry-graphql 0.223.0
File	Interpreter	ABI	Platform	Reset
strawberry_graphql-0.223.0-py3-none-any.whl 288.1 kB Mar 29, 2024	Python 3	none	any	Details

Total release size: 485.7 kB

Release files / strawberry_graphql-0.223.0.tar.gz

Download URL	strawberry_graphql-0.223.0.tar.gz
Size	197.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`e05a4b6a9c9b7a17598d1c2eb8e4dc77c35b8adf51eeba6373b5a81bdd6cc5ac`
BLAKE2b-256 checksum How to use checksums	`3a1063085b50dea5edf60573d0e59dc0f318bb8f4ca6c6246db3b431ec6365f9`
Upload date	Mar 29, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.2 CPython/3.10.14 Linux/6.5.0-1016-azure`

Release files / strawberry_graphql-0.223.0-py3-none-any.whl

Download URL	strawberry_graphql-0.223.0-py3-none-any.whl
Size	288.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`81d9ef0df75008301862aa1befbcd821c0886bdb8fd7e6aea722e204a2fb4639`
BLAKE2b-256 checksum How to use checksums	`2b6c86557b9bdd590dc0a0214d905657a0994a5ffc5f61c5dbbc076e9fb6a05c`
Upload date	Mar 29, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.2 CPython/3.10.14 Linux/6.5.0-1016-azure`