plain.admin 0.14.1__tar.gz

plain_admin-0.14.1/.gitignore

@@ -0,0 +1,16 @@
+.venv
+.env
+*.egg-info
+*.py[co]
+__pycache__
+*.DS_Store
+.coverage
+
+# Build files from publish
+plain*/dist/
+
+# Test apps
+plain*/tests/.plain
+
+# Ottobot
+.aider*

plain_admin-0.14.1/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.

plain_admin-0.14.1/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: plain.admin
+Version: 0.14.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
+
+# 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
+- 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 url
+
+## 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.14.1/README.md

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

plain_admin-0.14.1/plain/admin/README.md

@@ -0,0 +1,260 @@
+# 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
+- 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 url
+
+## 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.14.1/plain/admin/__init__.py

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

plain_admin-0.14.1/plain/admin/assets/admin/admin.css

@@ -0,0 +1,108 @@
+/*
+These standard CSS rules are intended to make it easier for the
+end-user to drop in HTML elements and have a decent, consistent starting point.
+
+We shouldn't use many custom classes in here (like .btn) because the user
+could unintentionally overwrite those since our CSS is combined.
+ */
+table {
+    width: 100%;
+    font-size: .875rem;
+    line-height: 1.25rem;
+    table-layout: auto;
+}
+
+th {
+    text-align: left;
+    padding: 0 0.5rem;
+    color: rgb(55, 65, 81);
+}
+
+table th a {
+    color: rgb(55, 65, 81);
+}
+
+tbody tr:hover {
+    background-color: rgb(255, 255, 255, 0.1);
+}
+
+td {
+    padding: 0.5rem 0.5rem;
+    white-space: nowrap;
+    border-bottom: 1px solid rgb(255, 255, 255, 0.1);
+}
+tr:last-child td {
+    border-bottom: none;
+}
+
+table img {
+    height: 1.2rem;
+    border-radius: 2px;
+}
+
+main a {
+    color: rgb(37, 99, 235);
+}
+
+main a:hover {
+    text-decoration: underline;
+}
+
+.actions a, .actions button, main button {
+    display: inline-block;
+    padding: 8px 16px;
+    font-size: 14px;
+    font-weight: 500;
+    color: #ffffff;
+    text-align: center;
+    text-decoration: none;
+    background-color: #2a2826;
+    border: 1px solid #3f3d3b;
+    border-radius: 6px;
+    transition: background-color 0.2s, border-color 0.2s, transform 0.2s;
+    cursor: pointer;
+
+    &:hover {
+        background-color: #2a2928;
+        border-color: #504e4c;
+        transform: translateY(-1px);
+    }
+
+    &:active {
+        background-color: #141312;
+        border-color: #3f3d3b;
+        transform: translateY(0);
+    }
+
+    &:focus {
+        outline: 2px solid #e5e7eb;
+        outline-offset: 2px;
+    }
+}
+
+/* Cards use these? */
+section {
+    border: rgba(255, 255, 255, 0.1) 1px solid;
+    border-radius: 0.275rem;
+    overflow: auto;
+    background-color: rgba(255, 255, 255, 0.05);
+    color: rgba(255, 255, 255, 0.8);
+    display: flex;
+    flex-direction: column;
+}
+
+section > header {
+    padding: 0.5rem;
+    /* background-color: #FFFCF0; */
+    border-bottom: rgba(255, 255, 255, 0.05) 1px solid;
+}
+
+section > div {
+    padding: 0.75rem 0.5rem;
+    flex-grow: 1;
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    justify-content: center;
+    overflow: auto;
+}