Need help with strawberry?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

strawberry-graphql
761 Stars 79 Forks MIT License 1.1K Commits 54 Opened issues

Description

A new GraphQL library for Python 🍓

Services available

!
?

Need anything else?

Contributors list

Strawberry GraphQL

Python GraphQL library based on dataclasses

CircleCI Discord PyPI

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

  1. Add the app to your
    INSTALLED_APPS
    .
INSTALLED_APPS = [
    ...
    'strawberry.django',
]
  1. 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]

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

Links

  • Project homepage: https://strawberry.rocks
  • Repository: https://github.com/strawberry-graphql/strawberry
  • Issue tracker: https://github.com/strawberry-graphql/strawberry/issues
    • In case of sensitive bugs like security vulnerabilities, please contact [email protected] directly instead of using the issue tracker. We value your effort to improve the security and privacy of this project!

Licensing

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.