PyPI - plain.admin - Versions diffs - 0.22.0__tar.gz → 0.23.0__tar.gz - Mend

plain.admin 0.22.0tar.gz → 0.23.0tar.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 (89) hide show

{plain_admin-0.22.0 → plain_admin-0.23.0}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.admin
-Version: 0.22.0
+Version: 0.23.0
 Summary: Admin dashboard and tools for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause
@@ -30,7 +30,47 @@ in addition to models.
 ## Installation
 - install plain.admin and plain.htmx, add plain.admin.admin and plain.htmx to installed packages
-- add url
+Add the `AdminRouter` to your `urls.py`.
+```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"),
+        # Your other urls here...
+    ]
+```
+Optionally, add the admin toolbar to your base template.
+```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>
+```
 ## Models in the admin
@@ -128,7 +168,9 @@ INSTALLED_PACKAGES += [
 ```html
 <!-- base.template.html -->
 {% load toolbar %}
 <!doctype html>
 <html lang="en">
   <head>
@@ -163,7 +205,6 @@ module.exports = {
 If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.
 # plain.requestlog
 The request log stores a local history of HTTP requests and responses during `plain work` (Django runserver).
@@ -228,7 +269,6 @@ module.exports = {
 If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.
 # plain.impersonate
 See what your users see.
@@ -269,7 +309,8 @@ urlpatterns = [
 By default, all admin users can impersonate other users.
-```python
+````python
 # settings.py
 IMPERSONATE_ALLOWED = lambda user: user.is_admin
 ``` -->
+````

{plain_admin-0.22.0 → plain_admin-0.23.0}/plain/admin/README.md RENAMED Viewed

@@ -15,7 +15,47 @@ in addition to models.
 ## Installation
 - install plain.admin and plain.htmx, add plain.admin.admin and plain.htmx to installed packages
-- add url
+Add the `AdminRouter` to your `urls.py`.
+```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"),
+        # Your other urls here...
+    ]
+```
+Optionally, add the admin toolbar to your base template.
+```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>
+```
 ## Models in the admin
@@ -113,7 +153,9 @@ INSTALLED_PACKAGES += [
 ```html
 <!-- base.template.html -->
 {% load toolbar %}
 <!doctype html>
 <html lang="en">
   <head>
@@ -148,7 +190,6 @@ module.exports = {
 If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.
 # plain.requestlog
 The request log stores a local history of HTTP requests and responses during `plain work` (Django runserver).
@@ -213,7 +254,6 @@ module.exports = {
 If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.
 # plain.impersonate
 See what your users see.
@@ -254,7 +294,8 @@ urlpatterns = [
 By default, all admin users can impersonate other users.
-```python
+````python
 # settings.py
 IMPERSONATE_ALLOWED = lambda user: user.is_admin
 ``` -->
+````

{plain_admin-0.22.0 → plain_admin-0.23.0}/plain/admin/config.py RENAMED Viewed

@@ -6,7 +6,7 @@ from plain.packages import PackageConfig, packages_registry, register_config
 @register_config
 class Config(PackageConfig):
-    label = "plainadmin"
+    package_label = "plainadmin"
     def ready(self):
         def _import_if_exists(module_name):

{plain_admin-0.22.0 → plain_admin-0.23.0}/plain/admin/querystats/README.md RENAMED Viewed

@@ -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_admin` 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.
@@ -69,7 +69,6 @@ module.exports = {
 If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.
 # plain.toolbar
 The admin toolbar is enabled for every user who `is_admin`.
@@ -125,7 +124,6 @@ module.exports = {
 If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.
 # plain.requestlog
 The request log stores a local history of HTTP requests and responses during `plain work` (Django runserver).

{plain_admin-0.22.0 → plain_admin-0.23.0}/pyproject.toml RENAMED Viewed

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

{plain_admin-0.22.0 → plain_admin-0.23.0}/tests/test_admin.py RENAMED Viewed

@@ -1,7 +1,11 @@
 from app.users.models import User
+from plain.test import Client
+def test_admin_login_required(db):
+    client = Client()
-def test_admin_login_required(db, client):
     # Login required
     assert client.get("/admin/").status_code == 302