Skip to main content

A library for creating GraphQL APIs

Project description

Strawberry GraphQL

Python GraphQL library based on dataclasses

CircleCI Discord PyPI

Installation

Install with:

pip install strawberry-graphql

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, info) -> 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)),
]

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

Uploaded Source

Built Distribution

strawberry_graphql-0.33.0-py3-none-any.whl (48.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for strawberry-graphql-0.33.0.tar.gz
Algorithm Hash digest
SHA256 3c90ad64f557a512c6c805205aef8f7bb68681c10242173d6c4047d424bbcc1a
MD5 6c0a34edb63e51b8cd8cdff027e5f88e
BLAKE2b-256 8d34b0cd7cf411bb1bea7e42a00aadb792b2ea2a6b64b5cb97be4addb99d1562

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for strawberry_graphql-0.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b5bdfd20d657de1a5ac4c2e3c731604e9097c85124870bb474305f46e05904fb
MD5 a034d731d6753fb64bf599c098614a6f
BLAKE2b-256 09a2dddc4af88b736568ff8481ddea2a68f4808dcf9e8bc411d9398993bf830a

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