Skip to main content

A library for creating GraphQL APIs

Project description

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) -> 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 = [
    ...,  # your other 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]'

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 --with integrations
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

Licensing

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

Recent Activity

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

strawberry_graphql-0.212.0.dev1698790124.tar.gz (189.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file strawberry_graphql-0.212.0.dev1698790124.tar.gz.

File metadata

File hashes

Hashes for strawberry_graphql-0.212.0.dev1698790124.tar.gz
Algorithm Hash digest
SHA256 f6a0a7dc455b9a2495c584e3b118adc461a8bc86d083364b0df68a7e02625cf4
MD5 8c9750b1873618f8f2d24403ed7fb893
BLAKE2b-256 3eae6520c2226a2c6dcc80c8b557a2b3dd23be8e7d82926623495a4d776ace03

See more details on using hashes here.

File details

Details for the file strawberry_graphql-0.212.0.dev1698790124-py3-none-any.whl.

File metadata

File hashes

Hashes for strawberry_graphql-0.212.0.dev1698790124-py3-none-any.whl
Algorithm Hash digest
SHA256 95a5c44ba519443414373b5818fdf3e98bb404b71d09cca87d574bf2799ede83
MD5 2e6e60649cf31e29cdfe368268fc9326
BLAKE2b-256 5adcd9e7964436bec3b65acdaa0e2c0c427e7f0876a7b530913730785c5efe58

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page