django-spec-html

A django-service-specs spec served over plain Django, with no API framework between the request and the kernel's dispatch. SpecFormView serves a spec whose Validator is a Django form as the page a person fills that form in on, and a refused post comes back as the page again with the refusal placed on its form. The page reads no htmx header: an htmx post is answered as any other, so a success is a redirect the request follows and a refusal is the whole page at a 4xx status, which htmx does not swap by default. A fragment answer for htmx is planned for 0.2.0. Beside the pages, SpecView, AsyncSpecView and dispatch_request serve a spec as JSON, for a script or a fetch().

Both halves are the kernel's, moved out with their history so the kernel carries no transport: the JSON views as kernel 0.11.0 shipped them, and SpecFormView as kernel 0.5.1 did. The behaviour is the kernel's, but for the page answering an UnsupportedMediaType an operation raises at 415 where the kernel's answered 400; the import path is this package's. The kernel no longer ships these names: import them from django_spec_html.

Install

pip install django-spec-html

Python 3.10 or later, Django 4.2 or later, and django-service-specs 0.12.0 or later, which it installs. Neither package needs an entry in INSTALLED_APPS.

Quickstart

A page, for a spec whose Validator is a FormValidator. GET renders the form; a valid POST dispatches and redirects; a refused one renders the form again with the refusal on it:

# yourapp/urls.py
from django.urls import path, reverse_lazy
from django_spec_html import SpecFormView

from yourapp.specs import add_book_spec  # a ServiceSpec with a FormValidator

urlpatterns = [
    path(
        "books/add/",
        SpecFormView.as_view(
            spec=add_book_spec,
            template_name="books/add.html",  # renders {{ form }} in a POST form
            success_url=reverse_lazy("books"),
        ),
    ),
]

A JSON view, for any spec. The view reads the arguments from the query string or the body and the route, dispatches, and answers the presented result, or the refusal at its status:

from django.urls import path
from django_spec_html import SpecView

from yourapp.specs import list_notes_spec, rename_note_spec

urlpatterns = [
    path("notes/", SpecView.as_view(spec=list_notes_spec)),
    path("notes/<int:pk>/rename/", SpecView.as_view(spec=rename_note_spec)),
]

Documentation

https://artui.github.io/django-spec-html/

License

MIT. See LICENSE.