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

For all further detail, check out the Contributing Page

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.229.2.dev1715873118.tar.gz (200.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file strawberry_graphql-0.229.2.dev1715873118.tar.gz.

File metadata

File hashes

Hashes for strawberry_graphql-0.229.2.dev1715873118.tar.gz
Algorithm Hash digest
SHA256 194f6f09f28b6c01cce26ed22a1cc53fee81bc5edc04a255db383ab3318f6099
MD5 c2a08dabc97b86a3055c6d7c73d0dc56
BLAKE2b-256 ca74d57c2023d4f64052e424f917f6a2eda85059546a4b6957da8eb216b62262

See more details on using hashes here.

File details

Details for the file strawberry_graphql-0.229.2.dev1715873118-py3-none-any.whl.

File metadata

File hashes

Hashes for strawberry_graphql-0.229.2.dev1715873118-py3-none-any.whl
Algorithm Hash digest
SHA256 791190518305174669e768208b56ddf3703bbfa5b1eff17735db307d74aca35a
MD5 a018720cee782e01cb5c1594ae85f686
BLAKE2b-256 312ced2bd5b2f6ea754d3f85d943c37e64ce161710a29bb3706e24d590458332

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