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
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.156.0.dev1676729888.tar.gz (149.7 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file strawberry_graphql-0.156.0.dev1676729888.tar.gz.

File metadata

File hashes

Hashes for strawberry_graphql-0.156.0.dev1676729888.tar.gz
Algorithm Hash digest
SHA256 5b9ac2023fb8e997f6f6d441cf094a779f2b45693e8bd2f1bdb1e86d12b2cbed
MD5 6a28c48f99fdbba8ff0518757dd4228e
BLAKE2b-256 71fd3f00ddd1fa72a8e853af36f86f67c0247dc9bfe57b0688bb07ff6b714e34

See more details on using hashes here.

File details

Details for the file strawberry_graphql-0.156.0.dev1676729888-py3-none-any.whl.

File metadata

File hashes

Hashes for strawberry_graphql-0.156.0.dev1676729888-py3-none-any.whl
Algorithm Hash digest
SHA256 a1e3a95066eaf40e970fd59de6422db2190cf003cfb7c44b3b56511408e08645
MD5 c9e23deb086da419f06a0b49ef86549a
BLAKE2b-256 95d507df6342acf5932aff6589398ccd841d0f5a82abea3c408e769da96253de

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