wagtail-unveil

Currently in active development. You should consider this package could be unstable and subject to breaking changes.

Discover and test every URL in your Wagtail site - frontend and admin.

Overview

Wagtail sites can accumulate many URLs across the admin site and frontend. Broken routes can hide until a user hits an error. wagtail-unveil discovers your URLs and helps you verify responses for your apps routes.

It exposes discovery through:

• JSON API endpoints (Bearer token auth)
• interactive HTML reports in Wagtail admin (superuser + DEBUG=True, or WAGTAIL_UNVEIL_ENABLE_PRODUCTION_REPORTS=True)
• a dedicated settings and diagnostics page in Wagtail admin (superuser + DEBUG=True, or WAGTAIL_UNVEIL_ENABLE_PRODUCTION_REPORTS=True)
• a platform HTML report for runtime and dependency inventory diagnostics
• a dashboard panel linking to the admin report, frontend report, platform report, and settings page
• a platform runtime API endpoint for Python/Wagtail/Django version and dependency inventory

Quick Start

Canonical documentation hub: wagtail-unveil documentation

pip install wagtail-unveil

The current PyPI release is still an alpha intended for early adopters and real-world testing, and breaking changes may still happen before a stable release. To track unreleased changes from GitHub instead, use:

pip install git+https://github.com/nm-packages/wagtail-unveil.git

Add to your INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    "wagtail_unveil",
    # ...
]

Include package URLs:

urlpatterns = [
    # ...
    path("unveil/", include("wagtail_unveil.urls")),
]

curl -H "Authorization: Bearer your-secret-key" http://localhost:8000/unveil/api/v1/backend-urls/
curl -H "Authorization: Bearer your-secret-key" http://localhost:8000/unveil/api/v1/frontend-urls/
curl -H "Authorization: Bearer your-secret-key" http://localhost:8000/unveil/api/v1/platform/

For installation details, configuration, API usage, reports, and extension recipes, use the documentation hub.

Compatibility

Documentation

• Documentation hub: wagtail-unveil docs
• Installation and setup: Getting Started
• Settings and API key configuration: Settings Reference
• Feature guides: Features
• JSON API reference: API Reference
• Recipes: Recipes
• Contributor docs: Contributing
• Sandbox contributor workflow: Development Guide

License

MIT