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 hard coded 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 a GraphQL playground 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.contrib.django',
]

Add the view to your urls.py file.

from strawberry.contrib.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.

Release files for strawberry-graphql 0.16.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.16.3
File	Size	Uploaded
strawberry-graphql-0.16.3.tar.gz	22.4 kB	Oct 14, 2019	Details

Built distribution (wheel)

Table of built distributions (wheels) for strawberry-graphql 0.16.3
File	Interpreter	ABI	Platform	Reset
strawberry_graphql-0.16.3-py3-none-any.whl 29.2 kB Oct 14, 2019	Python 3	none	any	Details

Total release size: 51.6 kB

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

Download URL	strawberry-graphql-0.16.3.tar.gz
Size	22.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`e83ed85e606d82a6743db754f22e953faf422ebdf5f55805db251e8f94e93bf1`
BLAKE2b-256 checksum How to use checksums	`3d36ebb42d34e31eb67db9e3069bfde06fdeec3b2a72f9706997878b62e92cdf`
Upload date	Oct 14, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/0.12.17 CPython/3.7.3 Linux/4.15.0-1043-aws`

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

Download URL	strawberry_graphql-0.16.3-py3-none-any.whl
Size	29.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`93627bf0f772411cc0422404281bf2af080347b9a7f77895262c268df735f8cc`
BLAKE2b-256 checksum How to use checksums	`eefee2c22080830d1bd8448fb48f27691e465ce566c3a81848911833f8c3ab85`
Upload date	Oct 14, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/0.12.17 CPython/3.7.3 Linux/4.15.0-1043-aws`