Rename plain-staff to plain-admin

Author: davegaeddert

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       matrix:
         python-version: ["3.11", "3.12", "3.13"]
-        package: ["plain", "plain-worker", "plain-flags", "plain-sessions", "plain-staff", "plain-oauth", "plain-models"]
+        package: ["plain", "plain-worker", "plain-flags", "plain-sessions", "plain-admin", "plain-oauth", "plain-models"]
 
     steps:
     - uses: actions/checkout@v4

README.md

@@ -28,6 +28,6 @@ With the official Plain ecosystem packages you can:
 - Add [OAuth login](https://plainframework.com/docs/plain-oauth/) and API access
 - Run tests with [pytest](https://plainframework.com/docs/plain-test/)
 - Run a [background job worker](https://plainframework.com/docs/plain-worker/)
-- Build [staff tooling and admin dashboards](https://plainframework.com/docs/plain-staff/)
+- Build [admin dashboard and tools](https://plainframework.com/docs/plain-admin/)
 
 Learn more at [plainframework.com](https://plainframework.com).

plain-staff/LICENSE renamed to plain-admin/LICENSE

@@ -0,0 +1 @@
+plain/admin/README.md

plain-admin/README.md

@@ -1,8 +1,8 @@
-# Staff
+# Admin
 
-An admin interface for staff users.
+An admin interface for admin users.
 
-The Plain Staff is a new packages built from the ground up.
+The Plain Admin is a new package built from the ground up.
 It leverages class-based views and standard URLs and templates to provide a flexible admin where
 you can quickly create your own pages and cards,
 in addition to models.
@@ -14,7 +14,7 @@ in addition to models.
 
 ## Installation
 
-- install plain.staff and plain.htmx, add plain.staff.admin and plain.htmx to installed packages
+- install plain.admin and plain.htmx, add plain.admin.admin and plain.htmx to installed packages
 - add url
 
 ## Models in the admin
@@ -45,14 +45,14 @@ which can typically be removed by using `select_related`,
 # settings.py
 INSTALLED_PACKAGES = [
     # ...
-    "plain.staff.querystats",
+    "plain.admin.querystats",
 ]
 
 MIDDLEWARE = [
     "plain.sessions.middleware.SessionMiddleware",
     "plain.auth.middleware.AuthenticationMiddleware",
 
-    "plain.staff.querystats.QueryStatsMiddleware",
+    "plain.admin.querystats.QueryStatsMiddleware",
     # Put additional middleware below querystats
     # ...
 ]
@@ -66,7 +66,7 @@ you can add the querystats to your frontend templates with this include:
 {% include "querystats/button.html" %}
 ```
 
-*Note that you will likely want to surround this with an if `DEBUG` or `is_staff` check.*
+*Note that you will likely want to surround this with an if `DEBUG` or `is_admin` check.*
 
 To view querystats you need to send a POST request to `?querystats=store` (i.e. via a `<form>`),
 and the template include is the easiest way to do that.
@@ -95,9 +95,9 @@ If you aren't using Tailwind, and don't intend to, open an issue to discuss othe
 
 # plain.toolbar
 
-The staff toolbar is enabled for every user who `is_staff`.
+The admin toolbar is enabled for every user who `is_admin`.
 
-![Plain staff toolbar](https://user-images.githubusercontent.com/649496/213781915-a2094f54-99b8-4a05-a36e-dee107405229.png)
+![Plain Admin toolbar](https://user-images.githubusercontent.com/649496/213781915-a2094f54-99b8-4a05-a36e-dee107405229.png)
 
 ## Installation
 
@@ -187,7 +187,7 @@ The default settings can be customized if needed:
 DEV_REQUESTS_IGNORE_PATHS = [
     "/sw.js",
     "/favicon.ico",
-    "/staff/jsi18n/",
+    "/admin/jsi18n/",
 ]
 DEV_REQUESTS_MAX = 50
 ```
@@ -223,7 +223,7 @@ With `impersonate` installed, you can impersonate a user by finding them in the
 
 ![](/docs/img/impersonate-admin.png)
 
-Then with the [staff toolbar](/docs/plain-toolbar/) enabled, you'll get a notice of the impersonation and a button to exit:
+Then with the [admin toolbar](/docs/plain-toolbar/) enabled, you'll get a notice of the impersonation and a button to exit:
 
 ![](/docs/img/impersonate-bar.png)
 
@@ -234,27 +234,27 @@ To impersonate users, you need the app, middleware, and URLs:
 ```python
 # settings.py
 INSTALLED_PACKAGES = INSTALLED_PACKAGES + [
-  "plain.staff.impersonate",
+  "plain.admin.impersonate",
 ]
 
 MIDDLEWARE = MIDDLEWARE + [
-  "plain.staff.impersonate.ImpersonateMiddleware",
+  "plain.admin.impersonate.ImpersonateMiddleware",
 ]
 ```
 
 ```python
 # urls.py
 urlpatterns = [
     # ...
-    path("impersonate/", include("plain.staff.impersonate.urls")),
+    path("impersonate/", include("plain.admin.impersonate.urls")),
 ]
 ```
 
 ## Settings
 
-By default, all staff users can impersonate other users.
+By default, all admin users can impersonate other users.
 
 ```python
 # settings.py
-IMPERSONATE_ALLOWED = lambda user: user.is_staff
+IMPERSONATE_ALLOWED = lambda user: user.is_admin
 ``` -->

plain-staff/plain/staff/README.md renamed to plain-admin/plain/admin/README.md

@@ -0,0 +1,5 @@
+from .middleware import AdminMiddleware
+
+__all__ = [
+    "AdminMiddleware",
+]

plain-admin/plain/admin/__init__.py

@@ -42,7 +42,7 @@ if (plainToolbar.shouldHide()) {
 
 window.addEventListener("load", function () {
     document.querySelector('[data-plaintoolbar-hide]').addEventListener('click', function() {
-        console.log("Hiding staff toolbar for 1 hour");
+        console.log("Hiding admin toolbar for 1 hour");
         plainToolbar.hideUntil(Date.now() + 3600000);
     });
     document.querySelector('[data-plaintoolbar-expand]').addEventListener('click', function() {

plain-staff/plain/staff/assets/staff/staff.css renamed to plain-admin/plain/admin/assets/admin/admin.css

@@ -14,7 +14,7 @@ class Sizes(Enum):
         LARGE = 3
         FULL = 4
 
-    template_name = "staff/cards/card.html"
+    template_name = "admin/cards/card.html"
     size: Sizes = Sizes.SMALL
     # unique_id: str  # Use for tying to dashboards, require it
 

plain-staff/plain/staff/assets/staff/staff.js renamed to plain-admin/plain/admin/assets/admin/admin.js

@@ -1,17 +1,17 @@
 from collections import defaultdict
 
+from plain.admin.dates import DatetimeRangeAliases
 from plain.models import Count
 from plain.models.functions import (
     TruncDate,
     TruncMonth,
 )
-from plain.staff.dates import DatetimeRangeAliases
 
 from .base import Card
 
 
 class ChartCard(Card):
-    template_name = "staff/cards/chart.html"
+    template_name = "admin/cards/chart.html"
 
     def get_template_context(self):
         context = super().get_template_context()

plain-staff/plain/staff/assets/staff/chart.js renamed to plain-admin/plain/admin/assets/admin/chart.js

@@ -2,7 +2,7 @@
 
 
 class TableCard(Card):
-    template_name = "staff/cards/table.html"
+    template_name = "admin/cards/table.html"
     size = Card.Sizes.FULL
 
     headers = []

plain-staff/plain/staff/assets/staff/jquery-3.6.1.slim.min.js renamed to plain-admin/plain/admin/assets/admin/jquery-3.6.1.slim.min.js

@@ -3,12 +3,10 @@
 
 from plain.packages import PackageConfig, packages
 
-MODULE_NAME = "staff"
-
 
 class Config(PackageConfig):
-    name = "plain.staff"
-    label = "plainstaff"
+    name = "plain.admin"
+    label = "plainadmin"
 
     def ready(self):
         def _import_if_exists(module_name):
@@ -17,7 +15,7 @@ def _import_if_exists(module_name):
 
         # Trigger register calls to fire by importing the modules
         for package_config in packages.get_package_configs():
-            _import_if_exists(f"{package_config.name}.{MODULE_NAME}")
+            _import_if_exists(f"{package_config.name}.admin")
 
-        # Also trigger for the root app/staff.py module
-        _import_if_exists(f"app.{MODULE_NAME}")
+        # Also trigger for the root app/admin.py module
+        _import_if_exists("app.admin")

plain-staff/plain/staff/assets/staff/list.js renamed to plain-admin/plain/admin/assets/admin/list.js

@@ -1,4 +1,4 @@
-TOOLBAR_CLASS = "plain.staff.toolbar.Toolbar"
+TOOLBAR_CLASS = "plain.admin.toolbar.Toolbar"
 TOOLBAR_VERSION: str = "dev"
 
 QUERYSTATS_IGNORE_URLS: list[str] = ["/assets/.*"]

plain-staff/plain/staff/assets/staff/popper.min.js renamed to plain-admin/plain/admin/assets/admin/popper.min.js

@@ -7,7 +7,7 @@ With `impersonate` installed, you can impersonate a user by finding them in the
 
 ![](/docs/img/impersonate-admin.png)
 
-Then with the [staff toolbar](/docs/plain-toolbar/) enabled, you'll get a notice of the impersonation and a button to exit:
+Then with the [admin toolbar](/docs/plain-toolbar/) enabled, you'll get a notice of the impersonation and a button to exit:
 
 ![](/docs/img/impersonate-bar.png)
 
@@ -18,27 +18,27 @@ To impersonate users, you need the app, middleware, and URLs:
 ```python
 # settings.py
 INSTALLED_PACKAGES = INSTALLED_PACKAGES + [
-  "plain.staff.impersonate",
+  "plain.admin.impersonate",
 ]
 
 MIDDLEWARE = MIDDLEWARE + [
-  "plain.staff.impersonate.ImpersonateMiddleware",
+  "plain.admin.impersonate.ImpersonateMiddleware",
 ]
 ```
 
 ```python
 # urls.py
 urlpatterns = [
     # ...
-    path("impersonate/", include("plain.staff.impersonate.urls")),
+    path("impersonate/", include("plain.admin.impersonate.urls")),
 ]
 ```
 
 ## Settings
 
-By default, all staff users can impersonate other users.
+By default, all admin users can impersonate other users.
 
 ```python
 # settings.py
-IMPERSONATE_ALLOWED = lambda user: user.is_staff
+IMPERSONATE_ALLOWED = lambda user: user.is_admin
 ```

plain-staff/plain/staff/assets/staff/tippy-bundle.umd.min.js renamed to plain-admin/plain/admin/assets/admin/tippy-bundle.umd.min.js

@@ -9,8 +9,8 @@ def can_impersonate_user(impersonator, target_user):
     if not can_be_impersonator(impersonator):
         return False
 
-    # You can't impersonate staff users
-    if target_user.is_staff:
+    # You can't impersonate admin users
+    if target_user.is_admin:
         return False
 
     return True

plain-staff/plain/staff/assets/toolbar/toolbar.js renamed to plain-admin/plain/admin/assets/toolbar/toolbar.js

@@ -5,4 +5,4 @@ def IMPERSONATE_ALLOWED(user):
     if hasattr(settings, "IMPERSONATE_ALLOWED"):
         return settings.IMPERSONATE_ALLOWED(user)
 
-    return user.is_staff
+    return user.is_admin

plain-staff/plain/staff/cards/__init__.py renamed to plain-admin/plain/admin/cards/__init__.py

@@ -2,8 +2,8 @@
 from .querystats.middleware import QueryStatsMiddleware
 
 
-class StaffMiddleware:
-    """All staff-related middleware in a single class."""
+class AdminMiddleware:
+    """All admin-related middleware in a single class."""
 
     def __init__(self, get_response):
         self.get_response = get_response

plain-staff/plain/staff/cards/base.py renamed to plain-admin/plain/admin/cards/base.py

@@ -22,14 +22,14 @@ which can typically be removed by using `select_related`,
 # settings.py
 INSTALLED_PACKAGES = [
     # ...
-    "plain.staff.querystats",
+    "plain.admin.querystats",
 ]
 
 MIDDLEWARE = [
     "plain.sessions.middleware.SessionMiddleware",
     "plain.auth.middleware.AuthenticationMiddleware",
 
-    "plain.staff.querystats.QueryStatsMiddleware",
+    "plain.admin.querystats.QueryStatsMiddleware",
     # Put additional middleware below querystats
     # ...
 ]
@@ -43,7 +43,7 @@ you can add the querystats to your frontend templates with this include:
 {% include "querystats/button.html" %}
 ```
 
-*Note that you will likely want to surround this with an if `DEBUG` or `is_staff` check.*
+*Note that you will likely want to surround this with an if `DEBUG` or `is_admin` check.*
 
 To view querystats you need to send a POST request to `?querystats=store` (i.e. via a `<form>`),
 and the template include is the easiest way to do that.
@@ -72,9 +72,9 @@ If you aren't using Tailwind, and don't intend to, open an issue to discuss othe
 
 # plain.toolbar
 
-The staff toolbar is enabled for every user who `is_staff`.
+The admin toolbar is enabled for every user who `is_admin`.
 
-![Plain staff toolbar](https://user-images.githubusercontent.com/649496/213781915-a2094f54-99b8-4a05-a36e-dee107405229.png)
+![Plain admin toolbar](https://user-images.githubusercontent.com/649496/213781915-a2094f54-99b8-4a05-a36e-dee107405229.png)
 
 ## Installation
 
@@ -164,7 +164,7 @@ The default settings can be customized if needed:
 DEV_REQUESTS_IGNORE_PATHS = [
     "/sw.js",
     "/favicon.ico",
-    "/staff/jsi18n/",
+    "/admin/jsi18n/",
 ]
 DEV_REQUESTS_MAX = 50
 ```

plain-staff/plain/staff/cards/charts.py renamed to plain-admin/plain/admin/cards/charts.py

@@ -59,10 +59,10 @@ def __call__(self, request):
 
         with connection.execute_wrapper(querystats):
             # Have to wrap this first call so it is included in the querystats,
-            # but we don't have to wrap everything else unless we are staff or debug
-            is_staff = self.is_staff_request(request)
+            # but we don't have to wrap everything else unless we are admin or debug
+            is_admin = self.is_admin_request(request)
 
-        if (settings.DEBUG or is_staff) and not self.should_ignore_request(request):
+        if (settings.DEBUG or is_admin) and not self.should_ignore_request(request):
             # Persist it on the thread
             _local.querystats = querystats
 
@@ -91,9 +91,9 @@ def __call__(self, request):
             return self.get_response(request)
 
     @staticmethod
-    def is_staff_request(request):
+    def is_admin_request(request):
         if getattr(request, "impersonator", None):
-            # Support for impersonation (still want the real staff user to see the querystats)
-            return request.impersonator and request.impersonator.is_staff
+            # Support for impersonation (still want the real admin user to see the querystats)
+            return request.impersonator and request.impersonator.is_admin
 
-        return hasattr(request, "user") and request.user and request.user.is_staff
+        return hasattr(request, "user") and request.user and request.user.is_admin

plain-staff/plain/staff/cards/tables.py renamed to plain-admin/plain/admin/cards/tables.py

@@ -6,7 +6,7 @@
 
 class QuerystatsView(AuthViewMixin, TemplateView):
     template_name = "querystats/querystats.html"
-    staff_required = True  # allow impersonator?
+    admin_required = True  # allow impersonator?
 
     def get_template_context(self):
         context = super().get_template_context()