Strawberry GraphQL

Python GraphQL library based on dataclasses

Installation

Install with:

pip install strawberry-graphql

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, info) -> 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)),
]

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.43.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.43.0
File	Size	Uploaded
strawberry-graphql-0.43.0.tar.gz	50.5 kB	Nov 18, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for strawberry-graphql 0.43.0
File	Interpreter	ABI	Platform	Reset
strawberry_graphql-0.43.0-py3-none-any.whl 70.8 kB Nov 18, 2020	Python 3	none	any	Details

Total release size: 121.3 kB

Release files / strawberry-graphql-0.43.0.tar.gz

Download URL	strawberry-graphql-0.43.0.tar.gz
Size	50.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`90ba5d42fdef3cb68d0325f4e64c722fd8224e3e249c84057cf0c4a47cfa36d0`
BLAKE2b-256 checksum How to use checksums	`27d614e20e8b0071b504e782ca7f325779a1ef958e011ea589481899fc432a35`
Upload date	Nov 18, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/0.12.17 CPython/3.7.3 Linux/4.15.0-1077-aws`

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

Download URL	strawberry_graphql-0.43.0-py3-none-any.whl
Size	70.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`801623a299fdb555045a32bdd783527d27bf140da05671c29b4c27e7d767dbc5`
BLAKE2b-256 checksum How to use checksums	`1f8c72edc24a136655189a09ebdf4d5f62929cec84b9427a34872b3df157dcaa`
Upload date	Nov 18, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/0.12.17 CPython/3.7.3 Linux/4.15.0-1077-aws`