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)),
]

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

Uploaded Source

Built Distribution

strawberry_graphql-0.276.0-py3-none-any.whl (306.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: strawberry_graphql-0.276.0.tar.gz
  • Upload date:
  • Size: 209.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.18 Linux/6.11.0-1018-azure

File hashes

Hashes for strawberry_graphql-0.276.0.tar.gz
Algorithm Hash digest
SHA256 a4c546d30d136342497c0ae351ea38a2c5eded6b95f4d09eb8cd0d05bd6b3a14
MD5 b5a831f27bafb43183daa6dc133b6d9a
BLAKE2b-256 a340b0f08a5e0dad31f52a11b8eac389c68d18d1587e2a4bc9887dd06b2e0e24

See more details on using hashes here.

File details

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

File metadata

  • Download URL: strawberry_graphql-0.276.0-py3-none-any.whl
  • Upload date:
  • Size: 306.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.18 Linux/6.11.0-1018-azure

File hashes

Hashes for strawberry_graphql-0.276.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e4e6b242c983757200466178fd2024e0dbee7d97181ca95d337969569be3d8f2
MD5 f23d6778c25317bcb61489c1093dc62f
BLAKE2b-256 5e3e76dc0d8f5ddf2dceac025bbc8e58e7eb4837c899f3909d321ab7f0e86dc4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page