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

Uploaded Source

Built Distribution

strawberry_graphql-0.116.1-py3-none-any.whl (160.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: strawberry-graphql-0.116.1.tar.gz
  • Upload date:
  • Size: 111.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.5 Linux/5.13.0-1031-azure

File hashes

Hashes for strawberry-graphql-0.116.1.tar.gz
Algorithm Hash digest
SHA256 087b503d674437f14bb1e160fb6b8a7e8defbc1a4f8e70f580ad66b7e4ee019c
MD5 b28ffe79690a26ea33ba61e623f6401e
BLAKE2b-256 b7ebf64f0cfb38fad4a5358ac6a1ad24fd6b0577925cf83b97a414c18b565dfd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for strawberry_graphql-0.116.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c49698dfd901e35dd5ac96d7ec7e3b497bcd413bba636df00eb3a5a5f3db25ba
MD5 f087fdcecb24bcfe1063c8a4ed7934a3
BLAKE2b-256 57ff4bb857acacdad5f11323a7b81e3ca8a011e725764aaedf4bff966110709e

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