dj-hyperview¶

New to Hyperview? Start with the Django-to-Hyperview request lifecycle, including a screen-to-fragment example.

Step-by-step SSE guide: setup, lists, forms and host responsibilities.

Serve consumer-owned Hyperview markup through Django without bundling application screens into the package.

Start here¶

1. Install dj-hyperview.
2. Serve your first screen.
3. Configure template resolution for your deployment.
4. Resolve a canonical template name through the public package API.
5. Explore HyperTodo, the maintained Django and Expo test application for dj-hyperview.

The package owns resolution, validation, raw-template caching, HTTP responses, and optional database publication. Your Django project owns every screen, schema, route, and application decision.

Release maturity¶

0.1.0b4 reduces repeated template compilation, rendered-document validation and Admin draft-check work. It retains the security and reliability corrections of 0.1.0b3 and the corrected 0.111.0 contract introduced in 0.1.0b2, now using bundled schema revision r4; 0.1.0b1 began the beta line. Review the beta compatibility policy, verified scope and roadmap before adoption. Entries under Unreleased in the changelog are not part of any release. Beta is not universal production proof.

Supported baseline¶

• Python 3.12 through 3.14.
• Django 5.2 and 6.1.
• Hyperview markup contract 0.111.0 in 0.1.0b4, b3 and b2; earlier b1 used 0.110.0. See Hyperview compatibility.

dj-hyperview does not ship application screens, runtime application HXML, Redis, or a required database app.

Choose the next guide for your source:

• Use filesystem sources for the smallest deployment.
• Publish through the database when editors need Django admin publication and optional HXML authoring. Schema validation is automatic and does not need this app.
• Configure cache consistency only when caching is needed.
• Harden names and XML before accepting authored templates.
• Add custom HXML elements when a mobile client extends the Hyperview vocabulary.
• Return documents and fragments with the right client contract.
• Create a mobile client, or compare the result with the HyperTodo test application.
• Test a consumer integration across supported Django versions.
• Release and roll back with reproducible gates.
• Review release changes before upgrading.

Use the public Python API reference when integrating package objects directly. Contributors should begin with the contributing guide.