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.125.0.dev1660322955.tar.gz (125.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file strawberry-graphql-0.125.0.dev1660322955.tar.gz.

File metadata

File hashes

Hashes for strawberry-graphql-0.125.0.dev1660322955.tar.gz
Algorithm Hash digest
SHA256 0279e8acdd1c6d20b6021d91d555e304d4d2e6ee80de6f056ce6aa92c4bc177f
MD5 e7268a43b9cfaeecb8142e79e291e43e
BLAKE2b-256 83a9da0b5e35468cf1b0c0d97095ccd5b367ed0d153c0b29d190710a58ed9ebd

See more details on using hashes here.

File details

Details for the file strawberry_graphql-0.125.0.dev1660322955-py3-none-any.whl.

File metadata

File hashes

Hashes for strawberry_graphql-0.125.0.dev1660322955-py3-none-any.whl
Algorithm Hash digest
SHA256 c7621aa09497ddfbfd03286c4b6899a309094f162855e64ca06ca06491ddb21b
MD5 0d1c87c067ef5873a6e9c40ffa63389e
BLAKE2b-256 3abbf3ec3f8b6461ff7431a8f5b620f6c881a5ac7f7cb88b3913ad072e222a7e

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