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 = [
    ...
    '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.

Metadata

Release files for strawberry-graphql 0.124.0.dev1659561253

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.124.0.dev1659561253
File	Size	Uploaded
strawberry-graphql-0.124.0.dev1659561253.tar.gz	117.8 kB	Aug 3, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for strawberry-graphql 0.124.0.dev1659561253
File	Interpreter	ABI	Platform	Reset
strawberry_graphql-0.124.0.dev1659561253-py3-none-any.whl 167.5 kB Aug 3, 2022	Python 3	none	any	Details

Total release size: 285.3 kB

Release files / strawberry-graphql-0.124.0.dev1659561253.tar.gz

Download URL	strawberry-graphql-0.124.0.dev1659561253.tar.gz
Size	117.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`6f0bd0b256db6d760df7d0e0bda51a2e6e364cc8e625f0737df544d950d7fd4e`
BLAKE2b-256 checksum How to use checksums	`1693d3323e22368a22b8661365692d12d9a428d47586596262637eedbc76694d`
Upload date	Aug 3, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.14 CPython/3.10.5 Linux/5.15.0-1014-azure`

Release files / strawberry_graphql-0.124.0.dev1659561253-py3-none-any.whl

Download URL	strawberry_graphql-0.124.0.dev1659561253-py3-none-any.whl
Size	167.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8202d3634c93ef7cfe664c18ac913ccf90b6efe8da25de106787af7245b78958`
BLAKE2b-256 checksum How to use checksums	`2a309ecc1a7ed7fd0bf2a675603180ed7f7f34cb0df5b687555926321ca87022`
Upload date	Aug 3, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.14 CPython/3.10.5 Linux/5.15.0-1014-azure`