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

Uploaded Source

Built Distribution

strawberry_graphql-0.248.1-py3-none-any.whl (297.1 kB view details)

Uploaded Python 3

File details

Details for the file strawberry_graphql-0.248.1.tar.gz.

File metadata

  • Download URL: strawberry_graphql-0.248.1.tar.gz
  • Upload date:
  • Size: 208.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.15 Linux/6.5.0-1025-azure

File hashes

Hashes for strawberry_graphql-0.248.1.tar.gz
Algorithm Hash digest
SHA256 d05870ada9f0ff3d536813834e7deb14f3b93a97f551d88be887c301b0c000ab
MD5 c979239cbf34dd1c1e7a97532e082a4c
BLAKE2b-256 76b24c7c6ec0e95df0dc11e6e7f688419f8d7faf49beb019cb7852bc4f3ad39e

See more details on using hashes here.

Provenance

File details

Details for the file strawberry_graphql-0.248.1-py3-none-any.whl.

File metadata

File hashes

Hashes for strawberry_graphql-0.248.1-py3-none-any.whl
Algorithm Hash digest
SHA256 04e0b966ff7972e668095824358766496d432fa61b38833bcb8d1b3115d88753
MD5 817f79fa405f1eb3b6c21b4434e5bd6a
BLAKE2b-256 85e2b647044ea2f3dc5a161234b204bfe57efc3d64e494a2cf93029e0cd1e551

See more details on using hashes here.

Provenance

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