Pre-release

This release is a pre-release and may not be stable for production use.

Strawberry GraphQL

Python GraphQL library based on dataclasses

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.

Add the app to your INSTALLED_APPS.

INSTALLED_APPS = [
    ...
    'strawberry.django',
]

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

Licensing

The code in this project is licensed under MIT license. See LICENSE for more information.

Metadata

Release files for strawberry-graphql 0.128.0.dev1662392213

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for strawberry-graphql 0.128.0.dev1662392213
File	Size	Uploaded	Provenance
strawberry-graphql-0.128.0.dev1662392213.tar.gz	133.7 kB	Sep 5, 2022	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for strawberry-graphql 0.128.0.dev1662392213
File	Interpreter	ABI	Platform	Reset
strawberry_graphql-0.128.0.dev1662392213-py3-none-any.whl 195.3 kB Sep 5, 2022 Without provenance	Python 3	none	any	Details

Total release size: 329.0 kB

Release files / strawberry-graphql-0.128.0.dev1662392213.tar.gz

Download URL	strawberry-graphql-0.128.0.dev1662392213.tar.gz
Size	133.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`407405cd46c391beea3db0a31531593677a8ea953455bc6a145b0758be563a20`
BLAKE2b-256 checksum How to use checksums	`e14c41e9c2f06d09dd6cd34cba313d83081cbe57e3f169a1a73a35773d029532`
Upload date	Sep 5, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.2.0 CPython/3.10.6 Linux/5.15.0-1017-azure`

Release files / strawberry_graphql-0.128.0.dev1662392213-py3-none-any.whl

Download URL	strawberry_graphql-0.128.0.dev1662392213-py3-none-any.whl
Size	195.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8ccb992286c747b27042dca716879a9c6a04ba6a6d5e5fccae35ad4c4471e191`
BLAKE2b-256 checksum How to use checksums	`a1ccf552ff291bf7c4d7d8ff5a88e45cf7eda0518813bb142aa6dfc1d670495d`
Upload date	Sep 5, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.2.0 CPython/3.10.6 Linux/5.15.0-1017-azure`

Security for strawberry-graphql 0.128.0.dev1662392213

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.