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

Uploaded Source

Built Distribution

strawberry_graphql-0.61.2-py3-none-any.whl (81.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: strawberry-graphql-0.61.2.tar.gz
  • Upload date:
  • Size: 59.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.3 Linux/4.15.0-1092-aws

File hashes

Hashes for strawberry-graphql-0.61.2.tar.gz
Algorithm Hash digest
SHA256 5c4b7a23a8c826f1d2e4728ffd281614b4e6265e73f1bd3ba2acbd165d4f5382
MD5 2c00acf735e29d848e869da68b29c166
BLAKE2b-256 be23ef7710669bed4af89470aa5351d67325b47e47066210f1f1ea64aa284c8d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for strawberry_graphql-0.61.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cf6e7a0321e464be4276ba016b43e95abb1c812d741a29ce8437c5aa0cf4f3b5
MD5 2e34db202be0a9334acc3320d641c494
BLAKE2b-256 52cf806c00a6d7b30aefb3224bd6312d07de902abb53f45ee7f1fb3177a27bf5

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