Grid View Spec
Declarative dashboard pages for Django and other hosts — tables, filters, KPI strips, charts, and export from one typed GridViewSpec contract. You own SQL/ORM rows; the package owns layout, templates, browser runtime, and PDF/XLSX pipelines.
Documentation · MCP server · PyPI
Core idea
| Layer | Owner |
|---|---|
| Data | Host — querysets, aggregates, authorization |
| Spec | GridViewSpec — blocks (GridViewTable, GridViewFilters, …) + layout |
| Render | Package — Jinja/Django HTML, gridviewspec.min.js, export |
from grid_view_spec import GridViewSpec, validate_spec
from grid_view_spec.types.layout import GridViewArea, GridViewLayout
from grid_view_spec.types.table_v2 import GridViewColumn, GridViewTable
spec = GridViewSpec(
id="orders",
blocks=(
GridViewTable(
id="orders_table",
backend="simple",
columns=(
GridViewColumn(id="name", label="Customer", field="name"),
GridViewColumn(id="amount", label="Amount", field="amount", type="currency"),
),
),
),
layout=GridViewLayout(root=GridViewArea(id="root", blocks=("orders_table",))),
)
validate_spec(spec)
{% load grid_view_spec %}
{% grid_view_spec_assets part='css' %}
{% render_grid_view_spec spec rows %}
{% grid_view_spec_assets part='js' force_core=True %}
Install
pip install "grid-view-spec[django]"
# optional:
pip install "grid-view-spec[django,pdf,xlsx,mcp]"
Django
INSTALLED_APPS = ["grid_view_spec.backends.django"]
python manage.py migrate grid_view_spec_django
urlpatterns = [
path("", include("grid_view_spec.backends.django.urls")),
]
See Getting started and Django integration.
Export
Register builders that return GridViewExportJob(spec, rows, table_id=…):
from grid_view_spec.export.registry import register_pdf_export, register_xlsx_export
from grid_view_spec.export.registry import GridViewExportJob
def register_exports():
def builder(host, ctx):
page = load_orders_page(ctx.request) # same loader as HTML view
return GridViewExportJob(spec=page.spec, rows=page.rows, table_id="orders_table")
register_pdf_export("orders", builder)
register_xlsx_export("orders", builder)
Browser links use ?builder=orders plus current filter query params. Details: Export page pattern.
AG-Grid, charts, MCP
- AG-Grid —
GridViewTable(backend="ag_grid")+ host JSON API; helpers ingrid_view_spec.backends.django.ag_grid - Charts / KPI — spec blocks + ECharts; values always from host
rows - MCP —
gridviewspec-mcpfor validation, catalog, migration hints (tools/mcp-server.md)
Development
uv sync
uv run pytest -q
uv run basedpyright --warnings src/grid_view_spec tests
cd frontend && npm run build && npm run typecheck
Pre-commit hooks: ruff, basedpyright, frontend typecheck/eslint, pytest.
License
MIT — see LICENSE.
1 maintainer
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 grid_view_spec-2.0.1.tar.gz.
File metadata
- Download URL: grid_view_spec-2.0.1.tar.gz
- Upload date:
- Size: 763.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0992626ec18ccdf4b4175dbbc4d2d5967471de01c416a67fe3e48d90c31176f6
|
|
| MD5 |
a95341506cb3530a2c91ccc289a0a8a2
|
|
| BLAKE2b-256 |
800d89eadd04d6eb7612ae215cb8cccce6512e63637009a194c9e0d584a30408
|
Provenance
The following attestation bundles were made for grid_view_spec-2.0.1.tar.gz:
Publisher:
ci.yml on alpiua/grid-view-spec
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
grid_view_spec-2.0.1.tar.gz -
Subject digest:
0992626ec18ccdf4b4175dbbc4d2d5967471de01c416a67fe3e48d90c31176f6 - Sigstore transparency entry: 2335679951
- Sigstore integration time:
-
Permalink:
alpiua/grid-view-spec@8e018beabddd5a997c5ed32250a4986b6fae21a8 -
Branch / Tag:
refs/tags/v2.0.1 - Owner: https://github.com/alpiua
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@8e018beabddd5a997c5ed32250a4986b6fae21a8 -
Trigger Event:
push
-
Statement type:
File details
Details for the file grid_view_spec-2.0.1-py3-none-any.whl.
File metadata
- Download URL: grid_view_spec-2.0.1-py3-none-any.whl
- Upload date:
- Size: 791.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ee48298624b92c3d1e34c3d550aa1b1f11b515270a782ae2008042addef6b7fb
|
|
| MD5 |
aed9553ee34cf8c862586c74b30059fd
|
|
| BLAKE2b-256 |
22cccb114f8ee7c3d33872240d09bd94c6587058ce3f7c98f9b504a77592b98e
|
Provenance
The following attestation bundles were made for grid_view_spec-2.0.1-py3-none-any.whl:
Publisher:
ci.yml on alpiua/grid-view-spec
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
grid_view_spec-2.0.1-py3-none-any.whl -
Subject digest:
ee48298624b92c3d1e34c3d550aa1b1f11b515270a782ae2008042addef6b7fb - Sigstore transparency entry: 2335679962
- Sigstore integration time:
-
Permalink:
alpiua/grid-view-spec@8e018beabddd5a997c5ed32250a4986b6fae21a8 -
Branch / Tag:
refs/tags/v2.0.1 - Owner: https://github.com/alpiua
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@8e018beabddd5a997c5ed32250a4986b6fae21a8 -
Trigger Event:
push
-
Statement type:
