wagtail-developer-reference 0.1.1__tar.gz → 0.1.3__tar.gz

{wagtail_developer_reference-0.1.1/wagtail_developer_reference.egg-info → wagtail_developer_reference-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wagtail-developer-reference
-Version: 0.1.1
+Version: 0.1.3
 Summary: A visual auditing tool for Wagtail developers to track Page models and StreamField blocks.
 Author-email: Four Digits <info@fourdigits.nl>
 Project-URL: Homepage, https://github.com/fourdigits/wagtail-developer-reference
@@ -14,9 +14,11 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-Requires-Dist: wagtail>=4.1
+Requires-Dist: wagtail<7.5,>=4.1
 Provides-Extra: dev
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
@@ -30,13 +32,17 @@ Requires-Dist: pytest-django; extra == "dev"
 In large Wagtail projects, it’s easy to lose track of where specific blocks are used or which templates are being rendered. This tool gives you a "God-view" of your components without needing to dig through the database or shell.
 
 ## Features
-* **Usage Tracking:** See exactly how many times a Page type or StreamField block is used across the site.
-* **Template Discovery:** Instantly see the file path for the template associated with every component.
-* **Interactive Audit:** Filter by type or search for specific field names to find where logic is implemented.
-* **Zero-Config:** No extra database tables or complex settings. It inspects your models and content on the fly.
+* **On-demand usage tracking:** Apply filters before calculating page and block usage, keeping the registry quick to open.
+* **Interactive registry:** Combine text, PAGE/BLOCK, site and total-usage-range filters to find exactly the components you need.
+* **Nested block discovery:** Browse visible block labels and full nested definition paths, with safe fallbacks for unlabeled blocks.
+* **Usage inspection:** Search and paginate matching pages, then copy the visible usage table in one click.
+* **Template discovery:** See the template path associated with every component.
 
 ## Installation
 
+Compatibility: Python 3.9+ and Wagtail 4.1 through 7.4.2 LTS (the latest
+stable Wagtail release at v0.1.3). Wagtail 7.4 itself requires Python 3.10+.
+
 1. Add \`wagtail_developer_reference\` to your \`INSTALLED_APPS\`:
    \`\`\`python
    INSTALLED_APPS = [
@@ -45,9 +51,24 @@ In large Wagtail projects, it’s easy to lose track of where specific blocks ar
    ]
    \`\`\`
 
-2. **Usage:**
-   * Login to the Wagtail Admin as a **superuser**.
+2. Run migrations so Django creates the package permission:
+   ```bash
+   python manage.py migrate
+   ```
+
+3. Grant access in the Django admin:
+   * Open a user or group in the Django admin.
+   * Assign **Wagtail developer reference | developer reference access | Can access the
+     Wagtail developer reference**.
+
+4. **Usage:**
+   * Login to the Wagtail Admin with an account that has that permission explicitly
+     assigned.
    * Find the **"System Registry"** item in the sidebar menu.
 
+By default, no account can see the menu item or access the URLs. Superusers are not
+granted access automatically by this package; assign the permission directly or
+through a group.
+
 ## License
 **Internal Use Only** - Copyright © 2026 Fourdigits. All rights reserved.

wagtail_developer_reference-0.1.3/README.md

@@ -0,0 +1,48 @@
+# Wagtail Developer Reference
+
+**A visual auditing tool for Wagtail developers.** This package provides a live registry of your project's architecture, making it easy to track Page models and StreamField blocks across complex, multi-site setups.
+
+## Why use this?
+In large Wagtail projects, it’s easy to lose track of where specific blocks are used or which templates are being rendered. This tool gives you a "God-view" of your components without needing to dig through the database or shell.
+
+## Features
+* **On-demand usage tracking:** Apply filters before calculating page and block usage, keeping the registry quick to open.
+* **Interactive registry:** Combine text, PAGE/BLOCK, site and total-usage-range filters to find exactly the components you need.
+* **Nested block discovery:** Browse visible block labels and full nested definition paths, with safe fallbacks for unlabeled blocks.
+* **Usage inspection:** Search and paginate matching pages, then copy the visible usage table in one click.
+* **Template discovery:** See the template path associated with every component.
+
+## Installation
+
+Compatibility: Python 3.9+ and Wagtail 4.1 through 7.4.2 LTS (the latest
+stable Wagtail release at v0.1.3). Wagtail 7.4 itself requires Python 3.10+.
+
+1. Add \`wagtail_developer_reference\` to your \`INSTALLED_APPS\`:
+   \`\`\`python
+   INSTALLED_APPS = [
+       ...,
+       "wagtail_developer_reference",
+   ]
+   \`\`\`
+
+2. Run migrations so Django creates the package permission:
+   ```bash
+   python manage.py migrate
+   ```
+
+3. Grant access in the Django admin:
+   * Open a user or group in the Django admin.
+   * Assign **Wagtail developer reference | developer reference access | Can access the
+     Wagtail developer reference**.
+
+4. **Usage:**
+   * Login to the Wagtail Admin with an account that has that permission explicitly
+     assigned.
+   * Find the **"System Registry"** item in the sidebar menu.
+
+By default, no account can see the menu item or access the URLs. Superusers are not
+granted access automatically by this package; assign the permission directly or
+through a group.
+
+## License
+**Internal Use Only** - Copyright © 2026 Fourdigits. All rights reserved.

{wagtail_developer_reference-0.1.1 → wagtail_developer_reference-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "wagtail-developer-reference"
-version = "0.1.1"
+version = "0.1.3"
 description = "A visual auditing tool for Wagtail developers to track Page models and StreamField blocks."
 readme = "README.md"
 authors = [{name = "Four Digits", email = "info@fourdigits.nl" }]
@@ -14,13 +14,15 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12"
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14"
 ]
 keywords = ["django", "wagtail", "audit", "streamfield"]
 dependencies = [
-    "wagtail>=4.1",
+    "wagtail>=4.1,<7.5",
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.9"
 
 [project.optional-dependencies]
 dev = [
@@ -44,7 +46,7 @@ include = ["wagtail_developer_reference*"]
 
 [tool.ruff]
 line-length = 88
-target-version = "py310"
+target-version = "py39"
 
 [tool.ruff.lint]
 select = ["E", "F", "W", "I"]

{wagtail_developer_reference-0.1.1 → wagtail_developer_reference-0.1.3}/setup.py

@@ -1,11 +1,11 @@
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
 setup(
     name="wagtail-developer-reference",
-    version="0.1.1",
+    version="0.1.3",
     packages=find_packages(),
     include_package_data=True,
     install_requires=[
-        "wagtail>=4.1",
+        "wagtail>=4.1,<7.5",
     ],
 )

wagtail_developer_reference-0.1.3/wagtail_developer_reference/__init__.py

@@ -0,0 +1 @@
+__version__: str = "0.1.2"

wagtail_developer_reference-0.1.3/wagtail_developer_reference/apps.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from django.apps import AppConfig
+
+
+class WagtailDeveloperReferenceConfig(AppConfig):
+    default_auto_field: str = "django.db.models.BigAutoField"
+    name: str = "wagtail_developer_reference"
+    verbose_name: str = "Wagtail developer reference"

wagtail_developer_reference-0.1.3/wagtail_developer_reference/migrations/0001_initial.py

@@ -0,0 +1,38 @@
+# Generated manually for wagtail-developer-reference.
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="DeveloperReferencePermission",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "developer reference access",
+                "verbose_name_plural": "developer reference access",
+                "permissions": (
+                    (
+                        "access_developer_reference",
+                        "Can access the Wagtail developer reference",
+                    ),
+                ),
+                "default_permissions": (),
+                "managed": False,
+            },
+        ),
+    ]

wagtail_developer_reference-0.1.3/wagtail_developer_reference/migrations/__init__.py

@@ -0,0 +1 @@
+

wagtail_developer_reference-0.1.3/wagtail_developer_reference/models.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from django.db import models
+
+
+class DeveloperReferencePermission(models.Model):
+    class Meta:
+        default_permissions: tuple[str, ...] = ()
+        managed: bool = False
+        permissions: tuple[tuple[str, str], ...] = (
+            (
+                "access_developer_reference",
+                "Can access the Wagtail developer reference",
+            ),
+        )
+        verbose_name: str = "developer reference access"
+        verbose_name_plural: str = "developer reference access"

{wagtail_developer_reference-0.1.1 → wagtail_developer_reference-0.1.3}/wagtail_developer_reference/templates/detail.html

@@ -98,6 +98,25 @@
 
     .empty-state p { font-size: 1.2rem; }
 
+    .registry-controls {
+        display: flex;
+        gap: 1rem;
+        margin-bottom: 1.5rem;
+        align-items: end;
+    }
+
+    .registry-controls {
+        background: #333; border-left: 0.3125rem solid #dcbd3d; padding: 1rem;
+    }
+    .registry-controls div:first-of-type { flex: 1; }
+    .registry-controls label { color: white; display: block; font-weight: bold; margin-bottom: 0.5rem; }
+    .registry-controls input {
+        background: #222; border: 0.0625rem solid #dcbd3d; box-sizing: border-box;
+        color: white; min-height: 2.5rem; padding: 0.6rem; width: 100%;
+    }
+    .usage-table-actions { display: flex; justify-content: flex-end; margin-top: 1rem; }
+    .copy-table-button { border-radius: 0; }
+
     [data-wagtail-theme="dark"] .listing tbody tr:hover {
         background-color: #333 !important;
     }
@@ -111,11 +130,21 @@
         <a href="{% url 'dev_reference' %}">&larr; Back to System Registry</a>
       </div>
       <h1>Locations for: <strong>{{ component_name }}</strong></h1>
-      <p>Found in {{ pages|length }} location{{ pages|length|pluralize }}</p>
+      <p>{{ page_obj.paginator.count }} location{{ page_obj.paginator.count|pluralize }} found</p>
     </div>
   </header>
 
   <div class="nice-padding">
+    <form method="get" class="registry-controls" role="search">
+      <input type="hidden" name="site" value="{{ site_filter }}">
+      <div>
+        <label for="usage-search">Search pages</label>
+        <input id="usage-search" type="search" name="q" value="{{ search_query }}" placeholder="Filter by page title or slug...">
+      </div>
+      <div>
+        <button type="submit" class="button">Search</button>
+      </div>
+    </form>
     <table class="listing" id="usage-table">
       <thead>
         <tr>
@@ -151,12 +180,38 @@
         {% endfor %}
       </tbody>
     </table>
+    <div class="usage-table-actions">
+      <button id="copy-usage-table" type="button" class="button button-secondary copy-table-button">Copy displayed table</button>
+    </div>
+    {% if page_obj.paginator.num_pages > 1 %}
+      <nav class="pagination" aria-label="Usage result pages">
+        {% if page_obj.has_previous %}
+          <a class="button" href="?site={{ site_filter|urlencode }}&amp;q={{ search_query|urlencode }}&amp;page={{ page_obj.previous_page_number }}">Previous</a>
+        {% endif %}
+        <span>Page {{ page_obj.number }} of {{ page_obj.paginator.num_pages }}</span>
+        {% if page_obj.has_next %}
+          <a class="button" href="?site={{ site_filter|urlencode }}&amp;q={{ search_query|urlencode }}&amp;page={{ page_obj.next_page_number }}">Next</a>
+        {% endif %}
+      </nav>
+    {% endif %}
   </div>
 
   <script>
     let currentSortCol = -1;
     let sortAsc = true;
 
+    function copyUsageTable() {
+        const headers = ["Page Title", "Status", "URL Path"];
+        const rows = Array.from(document.querySelectorAll("#usage-body .usage-row"));
+        const values = rows.map(row => [0, 1, 2].map(index => row.cells[index].innerText.trim().replace(/\s+/g, " ")));
+        const text = [headers, ...values].map(row => row.join("\t")).join("\n");
+        const button = document.getElementById("copy-usage-table");
+        navigator.clipboard.writeText(text).then(() => {
+            button.textContent = "Copied";
+            window.setTimeout(() => { button.textContent = "Copy displayed table"; }, 1500);
+        });
+    }
+
     function sortTable(colIdx) {
         const tbody = document.getElementById("usage-body");
         const rows = Array.from(tbody.querySelectorAll(".usage-row"));
@@ -173,12 +228,14 @@
             if (colIdx === 1) {
                 valA = parseInt(a.cells[colIdx].getAttribute('data-sort'));
                 valB = parseInt(b.cells[colIdx].getAttribute('data-sort'));
-                return sortAsc ? valA - valB : valB - valueA;
+                return sortAsc ? valA - valB : valB - valA;
             }
             valA = a.cells[colIdx].textContent.trim().toLowerCase();
             valB = b.cells[colIdx].textContent.trim().toLowerCase();
             return sortAsc ? valA.localeCompare(valB) : valB.localeCompare(valA);
         }).forEach(row => tbody.appendChild(row));
     }
+
+    document.getElementById("copy-usage-table").addEventListener("click", copyUsageTable);
   </script>
-{% endblock %}
+{% endblock %}