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.

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

Uploaded Source

Built Distribution

strawberry_graphql-0.127.4-py3-none-any.whl (180.9 kB view details)

Uploaded Python 3

File details

Details for the file strawberry-graphql-0.127.4.tar.gz.

File metadata

  • Download URL: strawberry-graphql-0.127.4.tar.gz
  • Upload date:
  • Size: 125.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.10.6 Linux/5.15.0-1017-azure

File hashes

Hashes for strawberry-graphql-0.127.4.tar.gz
Algorithm Hash digest
SHA256 a729d1dc0ade8fe33cb8412a747d1d7dd7950d82dd6467aaca752910804007f9
MD5 2a5d1b5be21c050f796a2c3de9f6feb5
BLAKE2b-256 91b705bd8ffc1bc8f72eb7b3cf5a20c3ad72cf882e685524fd97f92dbd131323

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for strawberry_graphql-0.127.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e04a1dff92127d09fcec3c6a6bd7f8cfdff62d634de4b834098ba8434cfde08e
MD5 da4d18dea7d7fc70d3551aa922fc8406
BLAKE2b-256 82e2fb4c0d00d45837a055ca4bc73b88522c74fe9dc8941a90041586df7f5ff6

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