django-grid-view 1.0.0

Declarative grid views for Django: Simple Table, AG-Grid helpers, KPI cards, ECharts, and an LLM-friendly GridViewSpec contract

Django Grid View

Declarative grid views for Django: Simple Table, AG-Grid helpers (HTMX-safe), KPI cards, ECharts charts, and an LLM-friendly GridViewSpec contract.

Full documentation: https://alpiua.github.io/django-grid-view/

Install

pip install django-grid-view

Quick start

# settings.py
INSTALLED_APPS = ["django_grid_view"]

# urls.py
urlpatterns = [path("", include("django_grid_view.urls"))]

from django_grid_view.tables import Column, SimpleTableConfig

config = SimpleTableConfig(
    grid_id="demo",
    columns=[Column(key="name", label="Name")],
    data=[{"name": "Ada"}, {"name": "Bob"}],
)

{% load django_grid_view %}
{% render_simple_table config %}

Run python manage.py migrate django_grid_view if you use saved AG-Grid preferences.

Features

Feature	Docs
Simple Table (sort, search, export)	Simple Table
AG-Grid + HTMX	AG-Grid integration
KPI + charts + unified artifact	Grid View artifacts
Python types (pyright/mypy)	Python types
Release notes	Changelog

Development

Requires uv. The lockfile (uv.lock) pins all dev tools; CI uses uv sync --frozen --group dev.

uv sync --group dev
uv run pytest
uv run ruff check .
uv run ruff format --check .
uv run basedpyright --warnings src/django_grid_view tests

Docs site (MkDocs):

./scripts/docs_serve.sh

Or manually (always use uv run mkdocs, not a global install):

uv sync --group dev
uv run python scripts/build_llm_context.py
uv run mkdocs build --strict
uv run mkdocs serve

Without uv: pip install -e ".[dev]" then the same pytest / ruff / basedpyright commands.

LLM agents: full doc bundle → docs/llm/django-grid-view-llm-context.md (skill).

Release

Tag v* on main — CI publishes to PyPI via trusted publishing (environment: pypi).

Documentation: push to main runs .github/workflows/docs.yml (mkdocs build --strict → GitHub Pages). Enable Settings → Pages → GitHub Actions once per repository.

License

MIT — see LICENSE.