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
poetry run pytest

This will install all the dependencies (including dev ones) and run the tests.

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.177.3

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.177.3
File	Size	Uploaded
strawberry_graphql-0.177.3.tar.gz	163.1 kB	May 19, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for strawberry-graphql 0.177.3
File	Interpreter	ABI	Platform	Reset
strawberry_graphql-0.177.3-py3-none-any.whl 241.6 kB May 19, 2023	Python 3	none	any	Details

Total release size: 404.8 kB

Release files / strawberry_graphql-0.177.3.tar.gz

Download URL	strawberry_graphql-0.177.3.tar.gz
Size	163.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`0421ad86d867047d3af90f225ae57166d62802457e3c65ff10b17a3af0cd3911`
BLAKE2b-256 checksum How to use checksums	`ae4e4550308e4a57a4eadd486f9a722d1188e5dfe761fe97f3dbc87b9a5112ee`
Upload date	May 19, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.5.0 CPython/3.10.11 Linux/5.15.0-1037-azure`

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

Download URL	strawberry_graphql-0.177.3-py3-none-any.whl
Size	241.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`eab39f235b9e42c05ad372e74aaa2cdd1d27c64dd702a10dcd82e253de8caf72`
BLAKE2b-256 checksum How to use checksums	`4665398cf10931d7403ec48ac395480148b756132f5123dae9404882a1f8d157`
Upload date	May 19, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.5.0 CPython/3.10.11 Linux/5.15.0-1037-azure`