This release is a pre-release and may not be stable for production use.
datasette-plugin-router
WIP router for Datasette plugins
Datasette plugins that have a lot of custom API endpoints can get tiresome to write by hand. datasette-plugin-router aims to be a small Python library that adds a FastAPI-like API for defining custom Datasette plugin endpoints.
- Define routes with familiar GET/POST decorators
- Define Pydantic-backed input/output schemas on JSON endpoints
register_routes()compatability- export to OpenAPI schema for codegen'ing clients
Sample usage:
from datasette import Response, hookimpl
from datasette_plugin_router import Router, Body
from pydantic import BaseModel
router = Router()
class Input(BaseModel):
id: int
name: str
class Output(BaseModel):
id_negative: int
name_upper: str
@router.POST(r"/-/demo1$", output=Output)
async def demo1(params: Body[Input]) -> Output:
output = Output(
id_negative=-1 * params.id,
name_upper=params.name.upper(),
)
return Response.json(output.model_dump())
@router.GET(r"/-/hello/(?P<name>.*)$")
async def hello(name: str):
return Response.html(f"<h1>Hello, {name}!</h1>")
@hookimpl
def register_routes():
return router.routes()
Request body validation errors
If a Body()-injected request body fails Pydantic validation — including an empty
body or malformed JSON — the router returns a 400 instead of a 500:
{
"error": "id: Input should be a valid integer, unable to parse string as an integer",
"errors": [{"type": "int_parsing", "loc": ["id"], "msg": "..."}]
}
errorjoins each field error as"<loc>: <msg>"(just<msg>when there is no location, e.g. malformed JSON) with"; ".errorsisValidationError.errors()minus theurl/ctx/inputfields.- Messages are Pydantic's
msgverbatim, so custom validator messages pass through.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file datasette_plugin_router-0.0.1a6.tar.gz.
File metadata
- Download URL: datasette_plugin_router-0.0.1a6.tar.gz
- Upload date:
- Size: 12.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6d6601f260d969a91fb6b66f587f2eb0daa1a2f89f8b15a46ad35fb08a51aae1
|
|
| MD5 |
c25659cf62ebeca8f00bb0b5ff5d7733
|
|
| BLAKE2b-256 |
130ed789da73a00aaecba667c53736a1354865de5903a4cb125ac284ffc74c5d
|
Provenance
The following attestation bundles were made for datasette_plugin_router-0.0.1a6.tar.gz:
Publisher:
publish.yml on datasette/datasette-plugin-router
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
datasette_plugin_router-0.0.1a6.tar.gz -
Subject digest:
6d6601f260d969a91fb6b66f587f2eb0daa1a2f89f8b15a46ad35fb08a51aae1 - Sigstore transparency entry: 2154856817
- Sigstore integration time:
-
Permalink:
datasette/datasette-plugin-router@1631b4004eaaeb370b35ee1071a5eeb17ed15661 -
Branch / Tag:
refs/tags/0.0.1a6 - Owner: https://github.com/datasette
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@1631b4004eaaeb370b35ee1071a5eeb17ed15661 -
Trigger Event:
release
-
Statement type:
File details
Details for the file datasette_plugin_router-0.0.1a6-py3-none-any.whl.
File metadata
- Download URL: datasette_plugin_router-0.0.1a6-py3-none-any.whl
- Upload date:
- Size: 13.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1eecc13f35761ee093bca356aab26c66218b310c9a1f0a0a91ab6a76d8166020
|
|
| MD5 |
abc2a3200d10613e1ab81b9690d5b758
|
|
| BLAKE2b-256 |
e842feec94b69cb22977b94666a41ad9f1d63476a9f0a2c57b0bfc75432bf239
|
Provenance
The following attestation bundles were made for datasette_plugin_router-0.0.1a6-py3-none-any.whl:
Publisher:
publish.yml on datasette/datasette-plugin-router
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
datasette_plugin_router-0.0.1a6-py3-none-any.whl -
Subject digest:
1eecc13f35761ee093bca356aab26c66218b310c9a1f0a0a91ab6a76d8166020 - Sigstore transparency entry: 2154857607
- Sigstore integration time:
-
Permalink:
datasette/datasette-plugin-router@1631b4004eaaeb370b35ee1071a5eeb17ed15661 -
Branch / Tag:
refs/tags/0.0.1a6 - Owner: https://github.com/datasette
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@1631b4004eaaeb370b35ee1071a5eeb17ed15661 -
Trigger Event:
release
-
Statement type:
