This release is a pre-release and may not be stable for production use.
dj-hyperview
Server-driven Hyperview UI for Django, with every screen owned by your project. Resolve, render, validate, cache, and publish mobile UI from filesystem or database templates without bundling application screens into the package.
- Consumer-owned screens — keep XML and HXML inside the Django project that defines the mobile application.
- Ordered template sources — resolve from configured filesystem directories, the optional database app, or custom source backends with explicit precedence.
- Live database publication — edit validated templates through Django admin and expose committed changes on the next request, with an optional HXML-aware Ace editor.
- Cache consistency — opt into a compatible Django cache backend, including Redis, with source-aware keys and generation-based invalidation. File-based caches are not supported.
- Django-native HTTP integration — use lazy template responses, class-based views, validated fragment responses, request metadata, content negotiation, and standard CSRF protection.
- Fail-closed validation — enforce canonical names, UTF-8, XML safety, configurable resource limits, and automatic XSD 1.1 validation against one corrected Hyperview 0.110.0 schema plus explicit project extensions.
dj-hyperview does not ship application screens, runtime application HXML, mobile components, Redis, or a required database app. Those choices remain under the consumer project's control.
Example application
HyperTodo is the maintained test application for dj-hyperview. It combines a Django backend with an Expo mobile client and demonstrates filesystem and database templates, fragment updates, shared caching, custom HXML components, themes, localization, biometrics, and file uploads.
Requirements
- Python: 3.12, 3.13, or 3.14
- Django: 5.2 or 6.1
- lxml: 6.1 or newer, below 7
- Hyperview contract: 0.110.0
Installation
# uv (recommended)
uv add dj-hyperview
# pip
pip install dj-hyperview
Register the base Django application:
INSTALLED_APPS = [
# Your project applications.
"dj_hyperview",
]
The base app performs no database, cache, or network access during startup. Database-backed templates and admin integration are optional.
Schema validation is automatic: xmlschema is a normal dependency, with no
profile or enable flag. The deprecated [schema] extra remains an empty
compatibility alias. Install the optional Admin authoring tools separately:
uv add "dj-hyperview[editor]"
The editor adds HXML completion, formatting, and context-free validation of unsaved source. Enable only that editor explicitly:
INSTALLED_APPS = [
"django_ace",
"dj_hyperview",
"dj_hyperview.contrib.database",
]
HYPERVIEW = {
"ADMIN": {
"EDITOR": True,
"PERMISSION": "sample_app.permissions.can_edit_hyperview",
},
}
Stored templates execute as Django template code. Template mutations therefore
default to superusers only. ADMIN.PERMISSION may be a callable receiving the
current request or a dotted path to one; it must return the literal boolean
True to grant add, change, and delete access.
Quick start
Create hyperview/screens/home.xml inside the consumer project:
<?xml version="1.0" encoding="UTF-8"?>
<doc xmlns="https://hyperview.org/hyperview">
<screen id="home">
<body>
<view>
<text>Hello from Django</text>
</view>
</body>
</screen>
</doc>
Configure the filesystem source in settings.py:
from pathlib import Path
BASE_DIR = Path(__file__).resolve().parent.parent
HYPERVIEW = {
"TEMPLATE_DIRS": [BASE_DIR / "hyperview"],
"SOURCES": [
{"BACKEND": "dj_hyperview.sources.FileSystemSource"},
],
}
Expose the screen through Django's URL configuration:
from django.urls import path
from dj_hyperview import HyperviewTemplateView
urlpatterns = [
path(
"hyperview/home/",
HyperviewTemplateView.as_view(template_name="screens/home.xml"),
name="hyperview-home",
),
]
A request to /hyperview/home/ returns the rendered document as
application/vnd.hyperview+xml.
Configuration
All package settings live under the HYPERVIEW dictionary. Sources are queried
in declaration order, and the first match wins:
HYPERVIEW = {
"TEMPLATE_DIRS": [BASE_DIR / "hyperview"],
"SOURCES": [
{"BACKEND": "dj_hyperview.contrib.database.sources.DatabaseSource"},
{"BACKEND": "dj_hyperview.sources.FileSystemSource"},
],
}
To publish templates through the database and Django admin, add the optional app and run migrations:
INSTALLED_APPS = [
# Django applications used by your project.
"django.contrib.admin",
"dj_hyperview",
"dj_hyperview.contrib.database",
]
python manage.py migrate
Caching remains disabled unless a non-empty HYPERVIEW["CACHE"] configuration
is supplied. See the configuration and cache guides before enabling a shared
backend.
Documentation
📚 Full documentation — including Installation, Quick Start, Mobile Getting Started, Configuration, Filesystem sources, Database and admin, Cache consistency, Security, HTTP responses, Changelog, and the public Python API.
The package is published at PyPI.
Development
See the contributing guide for the quality contract, supported test matrix, and release workflow.
uv sync --all-groups
uv run pytest
uv run ruff check .
uv run ruff format --check .
License
dj-hyperview is distributed under the MIT 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 dj_hyperview-0.1.0a19.tar.gz.
File metadata
- Download URL: dj_hyperview-0.1.0a19.tar.gz
- Upload date:
- Size: 99.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6897aa6588b0f652376a8922a7cc0cfa65c21122b2de8cc34a3527fc8b280a00
|
|
| MD5 |
5b406e073b8f0b62773dcc99b0afa547
|
|
| BLAKE2b-256 |
30eb6a9e1938650767ea8c6870f6018f6d3a047c944674aef6511dd7c63de216
|
Provenance
The following attestation bundles were made for dj_hyperview-0.1.0a19.tar.gz:
Publisher:
release.yml on eamigo86/dj-hyperview
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
dj_hyperview-0.1.0a19.tar.gz -
Subject digest:
6897aa6588b0f652376a8922a7cc0cfa65c21122b2de8cc34a3527fc8b280a00 - Sigstore transparency entry: 2769270220
- Sigstore integration time:
-
Permalink:
eamigo86/dj-hyperview@7bbb704abe17438386d75d80a266a1b9a7b2ec3a -
Branch / Tag:
refs/tags/v0.1.0a19 - Owner: https://github.com/eamigo86
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@7bbb704abe17438386d75d80a266a1b9a7b2ec3a -
Trigger Event:
push
-
Statement type:
File details
Details for the file dj_hyperview-0.1.0a19-py3-none-any.whl.
File metadata
- Download URL: dj_hyperview-0.1.0a19-py3-none-any.whl
- Upload date:
- Size: 125.4 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 |
d37b56067f7279c1f139d028cbf1b7a7581b5125b1011328051b522d4c98818a
|
|
| MD5 |
57960c50fd2a34cab0983f550e08b1d8
|
|
| BLAKE2b-256 |
90fec94bbd147f321bd3d5a0c4b74cf9cc8a58e8f045edb48934f542603987e4
|
Provenance
The following attestation bundles were made for dj_hyperview-0.1.0a19-py3-none-any.whl:
Publisher:
release.yml on eamigo86/dj-hyperview
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
dj_hyperview-0.1.0a19-py3-none-any.whl -
Subject digest:
d37b56067f7279c1f139d028cbf1b7a7581b5125b1011328051b522d4c98818a - Sigstore transparency entry: 2769270296
- Sigstore integration time:
-
Permalink:
eamigo86/dj-hyperview@7bbb704abe17438386d75d80a266a1b9a7b2ec3a -
Branch / Tag:
refs/tags/v0.1.0a19 - Owner: https://github.com/eamigo86
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@7bbb704abe17438386d75d80a266a1b9a7b2ec3a -
Trigger Event:
push
-
Statement type:
