Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ciscorn/starlette-graphene3
An ASGI app for using Graphene v3 with Starlette / FastAPI
https://github.com/ciscorn/starlette-graphene3
asgi fastapi graphene graphql python python3 starlette
Last synced: 2 months ago
JSON representation
An ASGI app for using Graphene v3 with Starlette / FastAPI
- Host: GitHub
- URL: https://github.com/ciscorn/starlette-graphene3
- Owner: ciscorn
- License: mit
- Created: 2020-06-29T02:11:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-11T14:10:51.000Z (over 1 year ago)
- Last Synced: 2024-09-27T09:43:16.605Z (3 months ago)
- Topics: asgi, fastapi, graphene, graphql, python, python3, starlette
- Language: Python
- Homepage:
- Size: 120 KB
- Stars: 101
- Watchers: 4
- Forks: 14
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-python-backend - Integrates with _FastAPI_
README
# starlette-graphene3
A simple ASGI app for using [Graphene](https://github.com/graphql-python/graphene) v3 with [Starlette](https://github.com/encode/starlette) / [FastAPI](https://github.com/tiangolo/fastapi).
[](https://codecov.io/gh/ciscorn/starlette-graphene3)
[](https://pypi.org/project/starlette-graphene3)
It supports:
- Queries and Mutations (over HTTP or WebSocket)
- Subscriptions (over WebSocket)
- File uploading (https://github.com/jaydenseric/graphql-multipart-request-spec)
- GraphiQL / GraphQL Playground
File uploading requires `python-multipart` to be installed.
## Alternatives
- [strawberry](https://github.com/strawberry-graphql/strawberry)
- [ariadne](https://github.com/mirumee/ariadne)
- [tartiflette](https://github.com/tartiflette/tartiflette) ([tartiflette-asgi](https://github.com/tartiflette/tartiflette-asgi))
## Installation
```bash
pip3 install -U starlette-graphene3
```
## Example
```python
import asyncio
import graphene
from graphene_file_upload.scalars import Upload
from starlette.applications import Starlette
from starlette_graphene3 import GraphQLApp, make_graphiql_handler
class User(graphene.ObjectType):
id = graphene.ID()
name = graphene.String()
class Query(graphene.ObjectType):
me = graphene.Field(User)
def resolve_me(root, info):
return {"id": "john", "name": "John"}
class FileUploadMutation(graphene.Mutation):
class Arguments:
file = Upload(required=True)
ok = graphene.Boolean()
def mutate(self, info, file, **kwargs):
return FileUploadMutation(ok=True)
class Mutation(graphene.ObjectType):
upload_file = FileUploadMutation.Field()
class Subscription(graphene.ObjectType):
count = graphene.Int(upto=graphene.Int())
async def subscribe_count(root, info, upto=3):
for i in range(upto):
yield i
await asyncio.sleep(1)
app = Starlette()
schema = graphene.Schema(query=Query, mutation=Mutation, subscription=Subscription)
app.mount("/", GraphQLApp(schema, on_get=make_graphiql_handler())) # Graphiql IDE
# app.mount("/", GraphQLApp(schema, on_get=make_playground_handler())) # Playground IDE
# app.mount("/", GraphQLApp(schema)) # no IDE
```
## GraphQLApp
`GraphQLApp(schema, [options...])`
```python
class GraphQLApp:
def __init__(
self,
schema: graphene.Schema, # Requied
*,
# Optional keyword parameters
on_get: Optional[
Callable[[Request], Union[Response, Awaitable[Response]]]
] = None, # optional HTTP handler for GET requests
context_value: ContextValue = None,
root_value: RootValue = None,
middleware: Optional[Middleware] = None,
error_formatter: Callable[[GraphQLError], Dict[str, Any]] = format_error,
logger_name: Optional[str] = None,
playground: bool = False, # deprecating
execution_context_class: Optional[Type[ExecutionContext]] = None,
):
```