PyPI - plain.admin - Versions diffs - 0.24.0__tar.gz → 0.25.1__tar.gz - Mend

plain.admin 0.24.0tar.gz → 0.25.1tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (91) hide show

{plain_admin-0.24.0 → plain_admin-0.25.1}/.gitignore RENAMED Viewed

@@ -11,3 +11,5 @@ plain*/tests/.plain
 # Ottobot
 .aider*
+/llms-full.txt

plain_admin-0.25.1/PKG-INFO ADDED Viewed

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: plain.admin
+Version: 0.25.1
+Summary: Admin dashboard and tools for Plain.
+Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: plain-auth<1.0.0
+Requires-Dist: plain-htmx<1.0.0
+Requires-Dist: plain-tailwind<1.0.0
+Requires-Dist: plain<1.0.0
+Requires-Dist: sqlparse>=0.2.2
+Description-Content-Type: text/markdown
+# plain.admin
+**Manage your app with a backend interface.**
+The Plain Admin provides a combination of built-in views and the flexibility to create your own. You can use it to quickly get visibility into your app's data and to manage it.
+![Plain Admin user example](https://assets.plainframework.com/docs/plain-pageviews-user.png)
+## Installation
+Install the `plain.admin` package and its dependencies.
+```console
+uv add plain.admin
+```
+The admin uses a combination of other Plain packages, most of which you will already have installed. Ultimately, your settings will look something like this:
+```python
+# app/settings.py
+INSTALLED_PACKAGES = [
+    "plain.models",
+    "plain.tailwind",
+    "plain.auth",
+    "plain.sessions",
+    "plain.htmx",
+    "plain.admin",
+    "plain.elements",
+    # other packages...
+]
+AUTH_USER_MODEL = "users.User"
+AUTH_LOGIN_URL = "login"
+MIDDLEWARE = [
+    "plain.sessions.middleware.SessionMiddleware",
+    "plain.auth.middleware.AuthenticationMiddleware",
+    "plain.admin.AdminMiddleware",
+]
+```
+Your User model is expected to have an `is_admin` field (or attribute) for checking who has permission to access the admin.
+```python
+# app/users/models.py
+from plain import models
+@models.register_model
+class User(models.Model):
+    is_admin = models.BooleanField(default=False)
+    # other fields...
+```
+To make the admin accessible, add the `AdminRouter` to your root URLs.
+```python
+# app/urls.py
+from plain.admin.urls import AdminRouter
+from plain.urls import Router, include, path
+from . import views
+class AppRouter(Router):
+    namespace = ""
+    urls = [
+        include("admin/", AdminRouter),
+        path("login/", views.LoginView, name="login"),
+        path("logout/", LogoutView, name="logout"),
+        # other urls...
+    ]
+```
+Optionally, you can add the admin toolbar to 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>
+```
+## Admin viewsets
+The most common use of the admin is to display and manage your `plain.models`. To do this, create a viewset with a set of inner views.
+```python
+# app/users/admin.py
+from plain.admin.views import (
+    AdminModelDetailView,
+    AdminModelListView,
+    AdminModelUpdateView,
+    AdminViewset,
+    register_viewset,
+)
+from plain.models.forms import ModelForm
+from .models import User
+class UserForm(ModelForm):
+    class Meta:
+        model = User
+        fields = ["email"]
+@register_viewset
+class UserAdmin(AdminViewset):
+    class ListView(AdminModelListView):
+        model = User
+        fields = [
+            "id",
+            "email",
+            "created_at__date",
+        ]
+        queryset_order = ["-created_at"]
+        search_fields = [
+            "email",
+        ]
+    class DetailView(AdminModelDetailView):
+        model = User
+    class UpdateView(AdminModelUpdateView):
+        template_name = "admin/users/user_form.html"
+        model = User
+        form_class = UserForm
+```
+The [`AdminViewset`](./views/viewsets.py) will automatically recognize inner views named `ListView`, `CreateView`, `DetailView`, `UpdateView`, and `DeleteView`. It will interlink these views automatically in the UI and form success URLs. You can define additional views too, but you will need to implement a couple methods to hook them up.
+## Admin cards
+TODO
+## Admin forms
+TODO
+## Toolbar
+TODO
+## Impersonate
+TODO
+## Querystats
+TODO

plain_admin-0.25.1/plain/admin/README.md ADDED Viewed

@@ -0,0 +1,163 @@
+# plain.admin
+**Manage your app with a backend interface.**
+The Plain Admin provides a combination of built-in views and the flexibility to create your own. You can use it to quickly get visibility into your app's data and to manage it.
+![Plain Admin user example](https://assets.plainframework.com/docs/plain-pageviews-user.png)
+## Installation
+Install the `plain.admin` package and its dependencies.
+```console
+uv add plain.admin
+```
+The admin uses a combination of other Plain packages, most of which you will already have installed. Ultimately, your settings will look something like this:
+```python
+# app/settings.py
+INSTALLED_PACKAGES = [
+    "plain.models",
+    "plain.tailwind",
+    "plain.auth",
+    "plain.sessions",
+    "plain.htmx",
+    "plain.admin",
+    "plain.elements",
+    # other packages...
+]
+AUTH_USER_MODEL = "users.User"
+AUTH_LOGIN_URL = "login"
+MIDDLEWARE = [
+    "plain.sessions.middleware.SessionMiddleware",
+    "plain.auth.middleware.AuthenticationMiddleware",
+    "plain.admin.AdminMiddleware",
+]
+```
+Your User model is expected to have an `is_admin` field (or attribute) for checking who has permission to access the admin.
+```python
+# app/users/models.py
+from plain import models
+@models.register_model
+class User(models.Model):
+    is_admin = models.BooleanField(default=False)
+    # other fields...
+```
+To make the admin accessible, add the `AdminRouter` to your root URLs.
+```python
+# app/urls.py
+from plain.admin.urls import AdminRouter
+from plain.urls import Router, include, path
+from . import views
+class AppRouter(Router):
+    namespace = ""
+    urls = [
+        include("admin/", AdminRouter),
+        path("login/", views.LoginView, name="login"),
+        path("logout/", LogoutView, name="logout"),
+        # other urls...
+    ]
+```
+Optionally, you can add the admin toolbar to 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>
+```
+## Admin viewsets
+The most common use of the admin is to display and manage your `plain.models`. To do this, create a viewset with a set of inner views.
+```python
+# app/users/admin.py
+from plain.admin.views import (
+    AdminModelDetailView,
+    AdminModelListView,
+    AdminModelUpdateView,
+    AdminViewset,
+    register_viewset,
+)
+from plain.models.forms import ModelForm
+from .models import User
+class UserForm(ModelForm):
+    class Meta:
+        model = User
+        fields = ["email"]
+@register_viewset
+class UserAdmin(AdminViewset):
+    class ListView(AdminModelListView):
+        model = User
+        fields = [
+            "id",
+            "email",
+            "created_at__date",
+        ]
+        queryset_order = ["-created_at"]
+        search_fields = [
+            "email",
+        ]
+    class DetailView(AdminModelDetailView):
+        model = User
+    class UpdateView(AdminModelUpdateView):
+        template_name = "admin/users/user_form.html"
+        model = User
+        form_class = UserForm
+```
+The [`AdminViewset`](./views/viewsets.py) will automatically recognize inner views named `ListView`, `CreateView`, `DetailView`, `UpdateView`, and `DeleteView`. It will interlink these views automatically in the UI and form success URLs. You can define additional views too, but you will need to implement a couple methods to hook them up.
+## Admin cards
+TODO
+## Admin forms
+TODO
+## Toolbar
+TODO
+## Impersonate
+TODO
+## Querystats
+TODO

{plain_admin-0.24.0 → plain_admin-0.25.1}/plain/admin/assets/admin/admin.js RENAMED Viewed

@@ -58,8 +58,13 @@ jQuery(function($) {
                 // Column already has a link, so don't add another
                 return;
             }
+            var autolinkUrl = $this.data("column-autolink");
+            if (!autolinkUrl) {
+                // No URL, so don't add a link
+                return;
+            }
             var $link = $(document.createElement("a"));
-            $link.attr("href", $this.data("column-autolink"));
+            $link.attr("href", autolinkUrl);
             $link.addClass("flex p-2 -m-2 text-white/80 hover:no-underline");
             $(this).wrapInner($link);
         })

{plain_admin-0.24.0 → plain_admin-0.25.1}/plain/admin/views/objects.py RENAMED Viewed

@@ -144,29 +144,29 @@ class AdminListView(HTMXViewMixin, AdminView):
             "admin/values/default.html",
         ]
-    def get_list_url(self) -> str | None:
-        return None
+    def get_list_url(self) -> str:
+        return ""
-    def get_create_url(self) -> str | None:
-        return None
+    def get_create_url(self) -> str:
+        return ""
-    def get_detail_url(self, obj) -> str | None:
-        return None
+    def get_detail_url(self, obj) -> str:
+        return ""
-    def get_update_url(self, obj) -> str | None:
-        return None
+    def get_update_url(self, obj) -> str:
+        return ""
-    def get_delete_url(self, obj) -> str | None:
-        return None
+    def get_delete_url(self, obj) -> str:
+        return ""
-    def get_object_url(self, obj) -> str | None:
+    def get_object_url(self, obj) -> str:
         if url := self.get_detail_url(obj):
             return url
         if url := self.get_update_url(obj):
             return url
         if url := self.get_delete_url(obj):
             return url
-        return None
+        return ""
     def get_object_links(self, obj) -> dict[str]:
         links = {}
@@ -191,20 +191,20 @@ class AdminListView(HTMXViewMixin, AdminView):
 class AdminCreateView(AdminView, CreateView):
     template_name = None
-    def get_list_url(self) -> str | None:
-        return None
+    def get_list_url(self) -> str:
+        return ""
-    def get_create_url(self) -> str | None:
-        return None
+    def get_create_url(self) -> str:
+        return ""
-    def get_detail_url(self, obj) -> str | None:
-        return None
+    def get_detail_url(self, obj) -> str:
+        return ""
-    def get_update_url(self, obj) -> str | None:
-        return None
+    def get_update_url(self, obj) -> str:
+        return ""
-    def get_delete_url(self, obj) -> str | None:
-        return None
+    def get_delete_url(self, obj) -> str:
+        return ""
     def get_success_url(self, form):
         if list_url := self.get_list_url():
@@ -274,20 +274,20 @@ class AdminDetailView(AdminView, DetailView):
         return templates
-    def get_list_url(self) -> str | None:
-        return None
+    def get_list_url(self) -> str:
+        return ""
-    def get_create_url(self) -> str | None:
-        return None
+    def get_create_url(self) -> str:
+        return ""
-    def get_detail_url(self, obj) -> str | None:
-        return None
+    def get_detail_url(self, obj) -> str:
+        return ""
-    def get_update_url(self, obj) -> str | None:
-        return None
+    def get_update_url(self, obj) -> str:
+        return ""
-    def get_delete_url(self, obj) -> str | None:
-        return None
+    def get_delete_url(self, obj) -> str:
+        return ""
     def get_fields(self):
         return self.fields.copy()  # Avoid mutating the class attribute itself
@@ -311,20 +311,20 @@ class AdminUpdateView(AdminView, UpdateView):
     template_name = None
     nav_section = ""
-    def get_list_url(self) -> str | None:
-        return None
+    def get_list_url(self) -> str:
+        return ""
-    def get_create_url(self) -> str | None:
-        return None
+    def get_create_url(self) -> str:
+        return ""
-    def get_detail_url(self, obj) -> str | None:
-        return None
+    def get_detail_url(self, obj) -> str:
+        return ""
-    def get_update_url(self, obj) -> str | None:
-        return None
+    def get_update_url(self, obj) -> str:
+        return ""
-    def get_delete_url(self, obj) -> str | None:
-        return None
+    def get_delete_url(self, obj) -> str:
+        return ""
     def get_description(self):
         return repr(self.object)
@@ -363,20 +363,20 @@ class AdminDeleteView(AdminView, DeleteView):
     def get_description(self):
         return repr(self.object)
-    def get_list_url(self) -> str | None:
-        return None
+    def get_list_url(self) -> str:
+        return ""
-    def get_create_url(self) -> str | None:
-        return None
+    def get_create_url(self) -> str:
+        return ""
-    def get_detail_url(self, obj) -> str | None:
-        return None
+    def get_detail_url(self, obj) -> str:
+        return ""
-    def get_update_url(self, obj) -> str | None:
-        return None
+    def get_update_url(self, obj) -> str:
+        return ""
-    def get_delete_url(self, obj) -> str | None:
-        return None
+    def get_delete_url(self, obj) -> str:
+        return ""
     def get_links(self):
         links = super().get_links()

{plain_admin-0.24.0 → plain_admin-0.25.1}/pyproject.toml RENAMED Viewed

@@ -1,6 +1,6 @@
 [project]
 name = "plain.admin"
-version = "0.24.0"
+version = "0.25.1"
 description = "Admin dashboard and tools for Plain."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"

plain.admin 0.24.0__tar.gz → 0.25.1__tar.gz

plain.admin 0.24.0tar.gz → 0.25.1tar.gz