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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for strawberry_graphql-0.156.0.dev1676725369.tar.gz
Algorithm Hash digest
SHA256 1c713062b94f51546d40ec10831c5beecb0a47a0e77cf73e0f69544f8a1bc9af
MD5 91a88c4e1645a86aa31eb93b02ca3294
BLAKE2b-256 9d32756f689d3a6f969b596b669002dfd071f19d564c105682b346af1e22e287

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for strawberry_graphql-0.156.0.dev1676725369-py3-none-any.whl
Algorithm Hash digest
SHA256 1728a3115f00fc4b397f2cacf95f13fa266606f3934d49dcab8c6e4f654582a9
MD5 972c91528a3f0a705e619eabff9960c5
BLAKE2b-256 399d17965abc3099d308db40dd2bfa8783047647149772a997c325a9168c9b40

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