Skip to main content

A library for creating GraphQL APIs

Project description

Strawberry GraphQL

Python GraphQL library based on dataclasses

CircleCI

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 hard coded user.

To run the debug server run the following command:

strawberry server app

Open the debug server by clicking on the follwing link: http://0.0.0.0:8000/graphql

This will open a GraphQL playground 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

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

Uploaded Source

Built Distribution

strawberry_graphql-0.16.0-py3-none-any.whl (28.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for strawberry-graphql-0.16.0.tar.gz
Algorithm Hash digest
SHA256 ca524817d2d5590abff58e5ef92ea5a73375f2091562fa6c3a7281e303f7cf33
MD5 8147faf1d55a82b31b2a674603b05354
BLAKE2b-256 2f3785c571a3e848a4f0cc0d20e5d3ef63f8138a6e071c6540898f5cbd9ad9b7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for strawberry_graphql-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a4c6ef756ee2d4a4debcfe61e75c2b2a40dfb236e129e03195ec19af412811e
MD5 2a525a19a44ef9bea557c8ea56699ed1
BLAKE2b-256 85ac8af9e375a54a6c08e0a70510a3db33126284abfa0f06c61d62fa1a12787b

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