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.103.0.dev1647276413.tar.gz (102.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file strawberry-graphql-0.103.0.dev1647276413.tar.gz.

File metadata

File hashes

Hashes for strawberry-graphql-0.103.0.dev1647276413.tar.gz
Algorithm Hash digest
SHA256 9eaed4561fc3aa64ca21b5533bbc2b81aa29505c98561eae7b4077ef798b9757
MD5 452879519a5fda6c038ef544d0f5d0a2
BLAKE2b-256 e674ee9c0dd71cb61100034773d6d08ec9571efccc9f33a134e08149d6e2e71c

See more details on using hashes here.

File details

Details for the file strawberry_graphql-0.103.0.dev1647276413-py3-none-any.whl.

File metadata

File hashes

Hashes for strawberry_graphql-0.103.0.dev1647276413-py3-none-any.whl
Algorithm Hash digest
SHA256 f762ea7828e6bc0a990c9d2a06edbf106fade712f4dd3d80d8b6cb076b204e51
MD5 fb1c23d19c84d1704ba2bc5312bec98d
BLAKE2b-256 57c095b7b89a0a5709cd6ef2dde2abfd77bac15598abd37eb4ab04e5384cc81e

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