Move admin toolbar to a new package plain-toolbar

davegaeddert · davegaeddert · commit e49d54bfea16 · 2025-08-22T21:52:27.000-05:00
diff --git a/demos/full/app/settings.py b/demos/full/app/settings.py
@@ -20,6 +20,7 @@
     "plain.sessions",
     "plain.support",
     "plain.tailwind",
+    "plain.toolbar",
     "plain.worker",
     "plain.redirection",
     "plain.observer",
diff --git a/demos/full/pyproject.toml b/demos/full/pyproject.toml
@@ -27,6 +27,7 @@ dependencies = [
     "plain-sessions",
     "plain-support",
     "plain-tailwind",
+    "plain-toolbar",
     "plain-tunnel",
     "plain-vendor",
     "plain-worker",
diff --git a/plain-admin/plain/admin/README.md b/plain-admin/plain/admin/README.md
@@ -178,23 +178,3 @@ class AppRouter(Router):
         # other urls...
     ]
 ```
-
-Typically you will also want to add the admin `{% toolbar %}` to the bottom of your base template. The toolbar will appear when `settings.DEBUG` or when `request.user.is_admin` (including in production!).
-
-```html
-<!-- app/templates/base.html -->
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-<meta name="viewport" content="width=device-width,  initial-scale=1.0">
-    <title>{{ html_title|default("My App") }}</title>
-    {% tailwind_css %}
-</head>
-<body>
-    {% block content required %}{% endblock %}
-
-    {% toolbar %}
-</body>
-</html>
-```
diff --git a/plain-admin/plain/admin/templates.py b/plain-admin/plain/admin/templates.py
@@ -1,22 +1,8 @@
-from plain.runtime import settings
-from plain.templates import register_template_extension, register_template_filter
-from plain.templates.jinja.extensions import InclusionTagExtension
+from plain.templates import register_template_filter
 
-from .toolbar import Toolbar
 from .views.registry import registry
 
 
-@register_template_extension
-class ToolbarExtension(InclusionTagExtension):
-    tags = {"toolbar"}
-    template_name = "toolbar/toolbar.html"
-
-    def get_context(self, context, *args, **kwargs):
-        context.vars["toolbar"] = Toolbar(request=context["request"])
-        context.vars["app_name"] = settings.APP_NAME
-        return context
-
-
 @register_template_filter
 def get_admin_model_detail_url(obj):
     return registry.get_model_detail_url(obj)
diff --git a/plain-admin/plain/admin/templates/admin/base.html b/plain-admin/plain/admin/templates/admin/base.html
@@ -247,7 +247,5 @@ <h1 class="font-semibold text-sm">{% block title %}{{ title }}{% endblock %}</h1
         </div>
 
     </div>
-
-    {% toolbar %}
 </body>
 </html>
diff --git a/plain-observer/plain/observer/admin.py b/plain-observer/plain/observer/admin.py
@@ -1,14 +1,10 @@
-from functools import cached_property
-
-from plain.admin.toolbar import ToolbarPanel, register_toolbar_panel
 from plain.admin.views import (
     AdminModelDetailView,
     AdminModelListView,
     AdminViewset,
     register_viewset,
 )
 
-from .core import Observer
 from .models import Span, Trace
 
 
@@ -81,20 +77,3 @@ def get_initial_queryset(self):
 
     class DetailView(AdminModelDetailView):
         model = Span
-
-
-@register_toolbar_panel
-class ObserverToolbarPanel(ToolbarPanel):
-    name = "Observer"
-    template_name = "toolbar/observer.html"
-    button_template_name = "toolbar/observer_button.html"
-
-    @cached_property
-    def observer(self):
-        """Get the Observer instance for this request."""
-        return Observer(self.request)
-
-    def get_template_context(self):
-        context = super().get_template_context()
-        context["observer"] = self.observer
-        return context
diff --git a/plain-observer/plain/observer/toolbar.py b/plain-observer/plain/observer/toolbar.py
@@ -0,0 +1,22 @@
+from functools import cached_property
+
+from plain.toolbar import ToolbarPanel, register_toolbar_panel
+
+from .core import Observer
+
+
+@register_toolbar_panel
+class ObserverToolbarPanel(ToolbarPanel):
+    name = "Observer"
+    template_name = "toolbar/observer.html"
+    button_template_name = "toolbar/observer_button.html"
+
+    @cached_property
+    def observer(self):
+        """Get the Observer instance for this request."""
+        return Observer(self.request)
+
+    def get_template_context(self):
+        context = super().get_template_context()
+        context["observer"] = self.observer
+        return context
diff --git a/plain-sessions/plain/sessions/admin.py b/plain-sessions/plain/sessions/admin.py
@@ -1,4 +1,3 @@
-from plain.admin.toolbar import ToolbarPanel, register_toolbar_panel
 from plain.admin.views import (
     AdminModelDetailView,
     AdminModelListView,
@@ -9,12 +8,6 @@
 from .models import Session
 
 
-@register_toolbar_panel
-class SessionToolbarPanel(ToolbarPanel):
-    name = "Session"
-    template_name = "toolbar/session.html"
-
-
 @register_viewset
 class SessionAdmin(AdminViewset):
     class ListView(AdminModelListView):
diff --git a/plain-sessions/plain/sessions/toolbar.py b/plain-sessions/plain/sessions/toolbar.py
@@ -0,0 +1,7 @@
+from plain.toolbar import ToolbarPanel, register_toolbar_panel
+
+
+@register_toolbar_panel
+class SessionToolbarPanel(ToolbarPanel):
+    name = "Session"
+    template_name = "toolbar/session.html"
diff --git a/plain-toolbar/LICENSE b/plain-toolbar/LICENSE
@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Dropseed, LLC
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/plain-toolbar/README.md b/plain-toolbar/README.md
@@ -0,0 +1,34 @@
+# plain.toolbar
+
+**Debug toolbar for Plain applications.**
+
+## Installation
+
+```bash
+uv add plain.toolbar
+```
+
+Add it to your `INSTALLED_PACKAGES`:
+
+```python
+# app/settings.py
+INSTALLED_PACKAGES = [
+    "plain.toolbar",
+    # other packages...
+]
+```
+
+Add the toolbar to your base template:
+
+```html
+<!-- app/templates/base.html -->
+<!DOCTYPE html>
+<html>
+<body>
+    {% block content required %}{% endblock %}
+    {% toolbar %}
+</body>
+</html>
+```
+
+The toolbar will appear when `settings.DEBUG` is True or when `request.user.is_admin` is True.
diff --git a/plain-toolbar/plain/toolbar/__init__.py b/plain-toolbar/plain/toolbar/__init__.py
@@ -0,0 +1,4 @@
+from .registry import register_toolbar_panel
+from .toolbar import ToolbarPanel
+
+__all__ = ["ToolbarPanel", "register_toolbar_panel"]
diff --git a/plain-toolbar/plain/toolbar/assets/toolbar/toolbar.js b/plain-toolbar/plain/toolbar/assets/toolbar/toolbar.js
diff --git a/plain-toolbar/plain/toolbar/config.py b/plain-toolbar/plain/toolbar/config.py
@@ -0,0 +1,19 @@
+from importlib import import_module
+from importlib.util import find_spec
+
+from plain.packages import PackageConfig, packages_registry, register_config
+
+
+@register_config
+class Config(PackageConfig):
+    def ready(self):
+        def _import_if_exists(module_name):
+            if find_spec(module_name):
+                import_module(module_name)
+
+        # Trigger register calls to fire by importing the toolbar modules
+        for package_config in packages_registry.get_package_configs():
+            _import_if_exists(f"{package_config.name}.toolbar")
+
+        # Also trigger for the root app/toolbar.py module
+        _import_if_exists("app.toolbar")
diff --git a/plain-toolbar/plain/toolbar/registry.py b/plain-toolbar/plain/toolbar/registry.py
@@ -0,0 +1,19 @@
+class ToolbarPanelRegistry:
+    def __init__(self):
+        self._panels = {}
+
+    def register_panel(self, panel_class):
+        self._panels[panel_class.name] = panel_class
+
+    def get_panels(self):
+        return self._panels.values()
+
+
+# Global registry instance
+registry = ToolbarPanelRegistry()
+
+
+def register_toolbar_panel(panel_class):
+    """Decorator to register a toolbar panel."""
+    registry.register_panel(panel_class)
+    return panel_class
diff --git a/plain-toolbar/plain/toolbar/templates.py b/plain-toolbar/plain/toolbar/templates.py
@@ -0,0 +1,16 @@
+from plain.runtime import settings
+from plain.templates import register_template_extension
+from plain.templates.jinja.extensions import InclusionTagExtension
+
+from .toolbar import Toolbar
+
+
+@register_template_extension
+class ToolbarExtension(InclusionTagExtension):
+    tags = {"toolbar"}
+    template_name = "toolbar/toolbar.html"
+
+    def get_context(self, context, *args, **kwargs):
+        context.vars["toolbar"] = Toolbar(request=context["request"])
+        context.vars["app_name"] = settings.APP_NAME
+        return context
diff --git a/plain-toolbar/plain/toolbar/templates/toolbar/exception.html b/plain-toolbar/plain/toolbar/templates/toolbar/exception.html
diff --git a/plain-toolbar/plain/toolbar/templates/toolbar/exception_button.html b/plain-toolbar/plain/toolbar/templates/toolbar/exception_button.html
diff --git a/plain-toolbar/plain/toolbar/templates/toolbar/request.html b/plain-toolbar/plain/toolbar/templates/toolbar/request.html
diff --git a/plain-toolbar/plain/toolbar/templates/toolbar/toolbar.html b/plain-toolbar/plain/toolbar/templates/toolbar/toolbar.html
diff --git a/plain-toolbar/plain/toolbar/toolbar.py b/plain-toolbar/plain/toolbar/toolbar.py
@@ -6,6 +6,8 @@
 from plain.urls.exceptions import Resolver404
 from plain.utils.safestring import mark_safe
 
+from .registry import register_toolbar_panel, registry
+
 
 class Toolbar:
     def __init__(self, request):
@@ -19,7 +21,7 @@ def should_render(self):
         if hasattr(self.request, "impersonator"):
             return self.request.impersonator.is_admin
 
-        if self.request.user:
+        if hasattr(self.request, "user"):
             return self.request.user.is_admin
 
         return False
@@ -35,7 +37,7 @@ def request_exception(self):
             return exception
 
     def get_panels(self):
-        panels = [panel(self.request) for panel in _toolbar_panel_registry.get_panels()]
+        panels = [panel(self.request) for panel in registry.get_panels()]
 
         if self.request_exception():
             exception = self.request_exception()
@@ -74,25 +76,6 @@ def render_button(self):
         return mark_safe(template.render(context))
 
 
-class _ToolbarPanelRegistry:
-    def __init__(self):
-        self._panels = {}
-
-    def register_panel(self, panel_class):
-        self._panels[panel_class.name] = panel_class
-
-    def get_panels(self):
-        return self._panels.values()
-
-
-_toolbar_panel_registry = _ToolbarPanelRegistry()
-
-
-def register_toolbar_panel(panel_class):
-    _toolbar_panel_registry.register_panel(panel_class)
-    return panel_class
-
-
 class _ExceptionToolbarPanel(ToolbarPanel):
     name = "Exception"
     template_name = "toolbar/exception.html"
diff --git a/plain-toolbar/pyproject.toml b/plain-toolbar/pyproject.toml
@@ -0,0 +1,21 @@
+[project]
+name = "plain.toolbar"
+version = "0.0.0"
+description = "Debug toolbar for Plain applications"
+authors = [
+    {name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"},
+]
+license = "BSD-3-Clause"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "plain<1.0.0",
+    "plain.tailwind<1.0.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["plain"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
diff --git a/pyproject.toml b/pyproject.toml
@@ -29,6 +29,7 @@ dev-dependencies = [
     "plain-sessions",
     "plain-support",
     "plain-tailwind",
+    "plain-toolbar",
     "plain-tunnel",
     "plain-vendor",
     "plain-worker",
@@ -59,6 +60,7 @@ dev-dependencies = [
 "plain-sessions" = { workspace = true }
 "plain-support" = { workspace = true }
 "plain-tailwind" = { workspace = true }
+"plain-toolbar" = { workspace = true }
 "plain-tunnel" = { workspace = true }
 "plain-vendor" = { workspace = true }
 "plain-worker" = { workspace = true }
diff --git a/uv.lock b/uv.lock

-Original file line number
+Diff line change
         </div>
     </div>
+-
 -    {% toolbar %}
 </body>
 </html>