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]'

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.86.0.dev1636672167.tar.gz (82.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file strawberry-graphql-0.86.0.dev1636672167.tar.gz.

File metadata

File hashes

Hashes for strawberry-graphql-0.86.0.dev1636672167.tar.gz
Algorithm Hash digest
SHA256 0e56c3d3341f57fb465a8209978c11888a10220b6c0d3c43d7a9d97abf673ac7
MD5 73afe040c0eafbb7e4fb8e1c334daa7b
BLAKE2b-256 20e875421c1b35bc9676efe57989baa0dd991e5c426d4d9cae572b962c6cecd4

See more details on using hashes here.

File details

Details for the file strawberry_graphql-0.86.0.dev1636672167-py3-none-any.whl.

File metadata

File hashes

Hashes for strawberry_graphql-0.86.0.dev1636672167-py3-none-any.whl
Algorithm Hash digest
SHA256 a3c0f7b48808d593fac1476500d118e5021f9445f916c2853cf5a3b31f0ef7d0
MD5 423cff464b541cd357f69f1bed722c25
BLAKE2b-256 fb4981d2db417a64b97fcd2ee2f718be77a074bd25f27c3dc7988f3f2dcc87cf

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