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 = [
    ...
    '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.141.0.tar.gz (136.4 kB view details)

Uploaded Source

Built Distribution

strawberry_graphql-0.141.0-py3-none-any.whl (193.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: strawberry_graphql-0.141.0.tar.gz
  • Upload date:
  • Size: 136.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.8 Linux/5.15.0-1022-azure

File hashes

Hashes for strawberry_graphql-0.141.0.tar.gz
Algorithm Hash digest
SHA256 5648d7357681fe2c24af0711733fc0a5a02a757bdc0065a891d3f8af27ec9c4b
MD5 e151098678d81c11923ad76691c3aec3
BLAKE2b-256 ee1aa3679048a750f95f0397179c087c95678960d688db0d994000ee130d9092

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for strawberry_graphql-0.141.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fd113cb33d865bb9b18bb8cb2e548083d291a27b5338e582a14c4bda0d8c817c
MD5 d99dbd63570000f50ede3341a8c0c09c
BLAKE2b-256 1bc4e66c0e1e3eeaa45e607a582b77cb752a90678993900b14fa0593383b0ac6

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