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

plain.admin 0.25.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.25.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.25.0 → plain_admin-0.25.1}/pyproject.toml RENAMED Viewed

@@ -1,6 +1,6 @@
 [project]
 name = "plain.admin"
-version = "0.25.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.25.0/PKG-INFO DELETED Viewed

@@ -1,316 +0,0 @@
-Metadata-Version: 2.4
-Name: plain.admin
-Version: 0.25.0
-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
-# Admin
-An admin interface for admin users.
-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.
-- cards
-- dashboards
-- diy forms - have to install elements if you want to use them (or an app uses them, or maybe plain pkgs should use them just for admin...)
-- detached from login (do your own login (oauth, passkeys, etc))
-## Installation
-- install plain.admin and plain.htmx, add plain.admin.admin and plain.htmx to installed packages
-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
-## Dashboards
-<!-- # plain.querystats
-On-page database query stats in development and production.
-On each page, the query stats will display how many database queries were performed and how long they took.
-[Watch on YouTube](https://www.youtube.com/watch?v=NX8VXxVJm08)
-Clicking the stats in the toolbar will show the full SQL query log with tracebacks and timings.
-This is even designed to work in production,
-making it much easier to discover and debug performance issues on production data!
-![Django query stats](https://user-images.githubusercontent.com/649496/213781593-54197bb6-36a8-4c9d-8294-5b43bd86a4c9.png)
-It will also point out duplicate queries,
-which can typically be removed by using `select_related`,
-`prefetch_related`, or otherwise refactoring your code.
-## Installation
-```python
-# settings.py
-INSTALLED_PACKAGES = [
-    # ...
-    "plain.admin.querystats",
-]
-MIDDLEWARE = [
-    "plain.sessions.middleware.SessionMiddleware",
-    "plain.auth.middleware.AuthenticationMiddleware",
-    "plain.admin.querystats.QueryStatsMiddleware",
-    # Put additional middleware below querystats
-    # ...
-]
-```
-We strongly recommend using the plain-toolbar along with this,
-but if you aren't,
-you can add the querystats to your frontend templates with this include:
-```html
-{% include "querystats/button.html" %}
-```
-*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.
-## Tailwind CSS
-This package is styled with [Tailwind CSS](https://tailwindcss.com/),
-and pairs well with [`plain-tailwind`](https://github.com/plainpackages/plain-tailwind).
-If you are using your own Tailwind implementation,
-you can modify the "content" in your Tailwind config to include any Plain packages:
-```js
-// tailwind.config.js
-module.exports = {
-  content: [
-    // ...
-    ".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
-  ],
-  // ...
-}
-```
-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`.
-![Plain Admin toolbar](https://user-images.githubusercontent.com/649496/213781915-a2094f54-99b8-4a05-a36e-dee107405229.png)
-## Installation
-Add `plaintoolbar` to your `INSTALLED_PACKAGES`,
-and the `{% toolbar %}` to your base template:
-```python
-# settings.py
-INSTALLED_PACKAGES += [
-    "plaintoolbar",
-]
-```
-```html
-<!-- base.template.html -->
-{% load toolbar %}
-<!doctype html>
-<html lang="en">
-  <head>
-    ...
-  </head>
-  <body>
-    {% toolbar %}
-    ...
-  </body>
-```
-More specific settings can be found below.
-## Tailwind CSS
-This package is styled with [Tailwind CSS](https://tailwindcss.com/),
-and pairs well with [`plain-tailwind`](https://github.com/plainpackages/plain-tailwind).
-If you are using your own Tailwind implementation,
-you can modify the "content" in your Tailwind config to include any Plain packages:
-```js
-// tailwind.config.js
-module.exports = {
-  content: [
-    // ...
-    ".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
-  ],
-  // ...
-}
-```
-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).
-The request history will make it easy to see redirects,
-400 and 500 level errors,
-form submissions,
-API calls,
-webhooks,
-and more.
-[Watch on YouTube](https://www.youtube.com/watch?v=AwI7Pt5oZnM)
-Requests can be re-submitted by clicking the "replay" button.
-[![Django request log](https://user-images.githubusercontent.com/649496/213781414-417ad043-de67-4836-9ef1-2b91404336c3.png)](https://user-images.githubusercontent.com/649496/213781414-417ad043-de67-4836-9ef1-2b91404336c3.png)
-## Installation
-```python
-# settings.py
-INSTALLED_PACKAGES += [
-    "plainrequestlog",
-]
-MIDDLEWARE = MIDDLEWARE + [
-    # ...
-    "plainrequestlog.RequestLogMiddleware",
-]
-```
-The default settings can be customized if needed:
-```python
-# settings.py
-DEV_REQUESTS_IGNORE_PATHS = [
-    "/sw.js",
-    "/favicon.ico",
-    "/admin/jsi18n/",
-]
-DEV_REQUESTS_MAX = 50
-```
-## Tailwind CSS
-This package is styled with [Tailwind CSS](https://tailwindcss.com/),
-and pairs well with [`plain-tailwind`](https://github.com/plainpackages/plain-tailwind).
-If you are using your own Tailwind implementation,
-you can modify the "content" in your Tailwind config to include any Plain packages:
-```js
-// tailwind.config.js
-module.exports = {
-  content: [
-    // ...
-    ".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
-  ],
-  // ...
-}
-```
-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.
-A key feature for providing customer support is to be able to view the site through their account.
-With `impersonate` installed, you can impersonate a user by finding them in the Django admin and clicking the "Impersonate" button.
-![](/docs/img/impersonate-admin.png)
-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)
-## Installation
-To impersonate users, you need the app, middleware, and URLs:
-```python
-# settings.py
-INSTALLED_PACKAGES = INSTALLED_PACKAGES + [
-  "plain.admin.impersonate",
-]
-MIDDLEWARE = MIDDLEWARE + [
-  "plain.admin.impersonate.ImpersonateMiddleware",
-]
-```
-```python
-# urls.py
-urlpatterns = [
-    # ...
-    path("impersonate/", include("plain.admin.impersonate.urls")),
-]
-```
-## Settings
-By default, all admin users can impersonate other users.
-````python
-# settings.py
-IMPERSONATE_ALLOWED = lambda user: user.is_admin
-``` -->
-````

plain_admin-0.25.0/plain/admin/README.md DELETED Viewed

@@ -1,301 +0,0 @@
-# Admin
-An admin interface for admin users.
-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.
-- cards
-- dashboards
-- diy forms - have to install elements if you want to use them (or an app uses them, or maybe plain pkgs should use them just for admin...)
-- detached from login (do your own login (oauth, passkeys, etc))
-## Installation
-- install plain.admin and plain.htmx, add plain.admin.admin and plain.htmx to installed packages
-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
-## Dashboards
-<!-- # plain.querystats
-On-page database query stats in development and production.
-On each page, the query stats will display how many database queries were performed and how long they took.
-[Watch on YouTube](https://www.youtube.com/watch?v=NX8VXxVJm08)
-Clicking the stats in the toolbar will show the full SQL query log with tracebacks and timings.
-This is even designed to work in production,
-making it much easier to discover and debug performance issues on production data!
-![Django query stats](https://user-images.githubusercontent.com/649496/213781593-54197bb6-36a8-4c9d-8294-5b43bd86a4c9.png)
-It will also point out duplicate queries,
-which can typically be removed by using `select_related`,
-`prefetch_related`, or otherwise refactoring your code.
-## Installation
-```python
-# settings.py
-INSTALLED_PACKAGES = [
-    # ...
-    "plain.admin.querystats",
-]
-MIDDLEWARE = [
-    "plain.sessions.middleware.SessionMiddleware",
-    "plain.auth.middleware.AuthenticationMiddleware",
-    "plain.admin.querystats.QueryStatsMiddleware",
-    # Put additional middleware below querystats
-    # ...
-]
-```
-We strongly recommend using the plain-toolbar along with this,
-but if you aren't,
-you can add the querystats to your frontend templates with this include:
-```html
-{% include "querystats/button.html" %}
-```
-*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.
-## Tailwind CSS
-This package is styled with [Tailwind CSS](https://tailwindcss.com/),
-and pairs well with [`plain-tailwind`](https://github.com/plainpackages/plain-tailwind).
-If you are using your own Tailwind implementation,
-you can modify the "content" in your Tailwind config to include any Plain packages:
-```js
-// tailwind.config.js
-module.exports = {
-  content: [
-    // ...
-    ".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
-  ],
-  // ...
-}
-```
-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`.
-![Plain Admin toolbar](https://user-images.githubusercontent.com/649496/213781915-a2094f54-99b8-4a05-a36e-dee107405229.png)
-## Installation
-Add `plaintoolbar` to your `INSTALLED_PACKAGES`,
-and the `{% toolbar %}` to your base template:
-```python
-# settings.py
-INSTALLED_PACKAGES += [
-    "plaintoolbar",
-]
-```
-```html
-<!-- base.template.html -->
-{% load toolbar %}
-<!doctype html>
-<html lang="en">
-  <head>
-    ...
-  </head>
-  <body>
-    {% toolbar %}
-    ...
-  </body>
-```
-More specific settings can be found below.
-## Tailwind CSS
-This package is styled with [Tailwind CSS](https://tailwindcss.com/),
-and pairs well with [`plain-tailwind`](https://github.com/plainpackages/plain-tailwind).
-If you are using your own Tailwind implementation,
-you can modify the "content" in your Tailwind config to include any Plain packages:
-```js
-// tailwind.config.js
-module.exports = {
-  content: [
-    // ...
-    ".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
-  ],
-  // ...
-}
-```
-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).
-The request history will make it easy to see redirects,
-400 and 500 level errors,
-form submissions,
-API calls,
-webhooks,
-and more.
-[Watch on YouTube](https://www.youtube.com/watch?v=AwI7Pt5oZnM)
-Requests can be re-submitted by clicking the "replay" button.
-[![Django request log](https://user-images.githubusercontent.com/649496/213781414-417ad043-de67-4836-9ef1-2b91404336c3.png)](https://user-images.githubusercontent.com/649496/213781414-417ad043-de67-4836-9ef1-2b91404336c3.png)
-## Installation
-```python
-# settings.py
-INSTALLED_PACKAGES += [
-    "plainrequestlog",
-]
-MIDDLEWARE = MIDDLEWARE + [
-    # ...
-    "plainrequestlog.RequestLogMiddleware",
-]
-```
-The default settings can be customized if needed:
-```python
-# settings.py
-DEV_REQUESTS_IGNORE_PATHS = [
-    "/sw.js",
-    "/favicon.ico",
-    "/admin/jsi18n/",
-]
-DEV_REQUESTS_MAX = 50
-```
-## Tailwind CSS
-This package is styled with [Tailwind CSS](https://tailwindcss.com/),
-and pairs well with [`plain-tailwind`](https://github.com/plainpackages/plain-tailwind).
-If you are using your own Tailwind implementation,
-you can modify the "content" in your Tailwind config to include any Plain packages:
-```js
-// tailwind.config.js
-module.exports = {
-  content: [
-    // ...
-    ".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
-  ],
-  // ...
-}
-```
-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.
-A key feature for providing customer support is to be able to view the site through their account.
-With `impersonate` installed, you can impersonate a user by finding them in the Django admin and clicking the "Impersonate" button.
-![](/docs/img/impersonate-admin.png)
-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)
-## Installation
-To impersonate users, you need the app, middleware, and URLs:
-```python
-# settings.py
-INSTALLED_PACKAGES = INSTALLED_PACKAGES + [
-  "plain.admin.impersonate",
-]
-MIDDLEWARE = MIDDLEWARE + [
-  "plain.admin.impersonate.ImpersonateMiddleware",
-]
-```
-```python
-# urls.py
-urlpatterns = [
-    # ...
-    path("impersonate/", include("plain.admin.impersonate.urls")),
-]
-```
-## Settings
-By default, all admin users can impersonate other users.
-````python
-# settings.py
-IMPERSONATE_ALLOWED = lambda user: user.is_admin
-``` -->
-````