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.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.
Metadata
Release files for strawberry-graphql 0.125.0.dev1660322955
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| strawberry-graphql-0.125.0.dev1660322955.tar.gz | 125.5 kB | Without provenance | Details for strawberry-graphql-0.125.0.dev1660322955.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| strawberry_graphql-0.125.0.dev1660322955-py3-none-any.whl | Python 3 | none | any | Details for strawberry_graphql-0.125.0.dev1660322955-py3-none-any.whl |
Total release size: 306.3 kB
Release files / strawberry-graphql-0.125.0.dev1660322955.tar.gz
| Download URL | strawberry-graphql-0.125.0.dev1660322955.tar.gz |
|---|---|
| Size | 125.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0279e8acdd1c6d20b6021d91d555e304d4d2e6ee80de6f056ce6aa92c4bc177f
|
|
BLAKE2b-256 checksum How to use checksums |
83a9da0b5e35468cf1b0c0d97095ccd5b367ed0d153c0b29d190710a58ed9ebd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.14 CPython/3.10.6 Linux/5.15.0-1014-azure
|
Release files / strawberry_graphql-0.125.0.dev1660322955-py3-none-any.whl
| Download URL | strawberry_graphql-0.125.0.dev1660322955-py3-none-any.whl |
|---|---|
| Size | 180.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c7621aa09497ddfbfd03286c4b6899a309094f162855e64ca06ca06491ddb21b
|
|
BLAKE2b-256 checksum How to use checksums |
3abbf3ec3f8b6461ff7431a8f5b620f6c881a5ac7f7cb88b3913ad072e222a7e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.14 CPython/3.10.6 Linux/5.15.0-1014-azure
|
Security for strawberry-graphql 0.125.0.dev1660322955
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.
