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.115.0.dev1656535533.tar.gz (110.7 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file strawberry-graphql-0.115.0.dev1656535533.tar.gz.

File metadata

File hashes

Hashes for strawberry-graphql-0.115.0.dev1656535533.tar.gz
Algorithm Hash digest
SHA256 16e9e2f1a73073d57eae7fa1ad042a8b56fbeed002f30275cd377f594eba61e4
MD5 6915f39751ca9d4860b6ff3913b66924
BLAKE2b-256 aa49563501602f2f6ef7218aec6133b1022389518ba92d936b01603ac2ad341a

See more details on using hashes here.

File details

Details for the file strawberry_graphql-0.115.0.dev1656535533-py3-none-any.whl.

File metadata

File hashes

Hashes for strawberry_graphql-0.115.0.dev1656535533-py3-none-any.whl
Algorithm Hash digest
SHA256 9225113c76b5b2123f36c032bbd6566984100cb9b25cf8722d54bc35dda5aac0
MD5 2e2316ae596530d1a1ca2761e4fd6844
BLAKE2b-256 d8d2bb334847a93d4b3a8753fe4d3bec480d7276c7caf0a71fa1fb1aaac9498d

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