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.197.0.dev1690539957.tar.gz (181.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file strawberry_graphql-0.197.0.dev1690539957.tar.gz.

File metadata

File hashes

Hashes for strawberry_graphql-0.197.0.dev1690539957.tar.gz
Algorithm Hash digest
SHA256 a3e1c1267764a82fa481c409c47ca6c2f174edb27996af3b778620bb715dd2e7
MD5 df272356b3a9aee7cd6ef9d946fcf084
BLAKE2b-256 551e152de9710d52c866c2f99191b0abdf5174a624e72e00bb3849a315ae5e64

See more details on using hashes here.

File details

Details for the file strawberry_graphql-0.197.0.dev1690539957-py3-none-any.whl.

File metadata

File hashes

Hashes for strawberry_graphql-0.197.0.dev1690539957-py3-none-any.whl
Algorithm Hash digest
SHA256 fa30c0deed1a3556ae2c96c7e5f98285a387d2278a5206c2e70daf1715a47112
MD5 8c8ce5d8b4a6225332a9b95f4a0f4a78
BLAKE2b-256 58cf1e8629fbc7271a13ee09e087d921623b1044433e9340c0e4588ea57e81b0

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