A library for creating GraphQL APIs
Project description
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.pyfile.
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
- Various examples on how to use Strawberry
- Full stack example using Starlette, SQLAlchemy, Typescript codegen and Next.js
- Quart + Strawberry tutorial
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
- Project homepage: https://strawberry.rocks
- Repository: https://github.com/strawberry-graphql/strawberry
- Issue tracker: https://github.com/strawberry-graphql/strawberry/issues
- In case of sensitive bugs like security vulnerabilities, please contact patrick.arminio@gmail.com directly instead of using the issue tracker. We value your effort to improve the security and privacy of this project!
Licensing
The code in this project is licensed under MIT license. See LICENSE for more information.
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
Built Distribution
File details
Details for the file strawberry-graphql-0.125.1.tar.gz.
File metadata
- Download URL: strawberry-graphql-0.125.1.tar.gz
- Upload date:
- Size: 125.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.14 CPython/3.10.6 Linux/5.15.0-1017-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3abb7a891e652eb26ae48c88381348414a9911d8ac75091813aa8f0fda890367 |
|
| MD5 | fea531c3a6db1ac6acff3ce9a4cb453b |
|
| BLAKE2b-256 | 04260aa6895ed493fca538200c652e13ede0937c689e32842693530445f6f272 |
File details
Details for the file strawberry_graphql-0.125.1-py3-none-any.whl.
File metadata
- Download URL: strawberry_graphql-0.125.1-py3-none-any.whl
- Upload date:
- Size: 180.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.14 CPython/3.10.6 Linux/5.15.0-1017-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c44bb142b055ca7f41cb07898038b86d82aff165e8aa03c8b1184b313d606b2a |
|
| MD5 | 3d2997a4db47fa5b10519948866ad0bc |
|
| BLAKE2b-256 | 5837cf41047ab3e3a1dfda576c42d057aa9cdc84d26cddb19652ad3468f7303d |
