Rebuild assets as a view

Author: davegaeddert

plain-auth/README.md

@@ -24,7 +24,6 @@ INSTALLED_PACKAGES = [
 
 MIDDLEWARE = [
     "plain.middleware.security.SecurityMiddleware",
-    "plain.assets.whitenoise.middleware.WhiteNoiseMiddleware",
     "plain.sessions.middleware.SessionMiddleware",  # <--
     "plain.middleware.common.CommonMiddleware",
     "plain.csrf.middleware.CsrfViewMiddleware",

plain-auth/plain/auth/README.md

@@ -22,7 +22,6 @@ INSTALLED_PACKAGES = [
 
 MIDDLEWARE = [
     "plain.middleware.security.SecurityMiddleware",
-    "plain.assets.whitenoise.middleware.WhiteNoiseMiddleware",
     "plain.sessions.middleware.SessionMiddleware",  # <--
     "plain.middleware.common.CommonMiddleware",
     "plain.csrf.middleware.CsrfViewMiddleware",

plain-importmap/test_project/settings.py

@@ -59,8 +59,3 @@
 USE_L10N = True
 
 USE_TZ = True
-
-
-# Static files (CSS, JavaScript, Images)
-
-ASSETS_URL = "/assets/"

plain-oauth/tests/settings.py

@@ -40,8 +40,6 @@
 USE_TZ = True
 TIME_ZONE = "UTC"
 
-ASSETS_URL = "/assets/"
-
 AUTH_LOGIN_URL = "login"
 LOGOUT_REDIRECT_URL = "/"
 

plain-pytest/plain/pytest/cli.py

@@ -29,6 +29,8 @@ def cli(pytest_args):
     #         pytest_args.append("-W")
     #         pytest_args.append("error::DeprecationWarning")
 
+    # has to happen before setup() to be more useful? initial setup() may fail if doesn't have the required variables
+    # or don't set it by default at all... could warn on != TEST?
     os.environ.setdefault("PLAIN_ENV", "test")
 
     click.secho(f"Running pytest with PLAIN_ENV={os.environ['PLAIN_ENV']}", bold=True)

plain-staff/README.md

@@ -1,3 +1,266 @@
 <!-- This file is compiled from plain-staff/plain/staff/README.md. Do not edit this file directly. -->
 
 # Staff
+
+An admin interface for staff users.
+
+The Plain Staff is a new packages 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.staff and plain.htmx, add plain.staff.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.staff.querystats",
+]
+
+MIDDLEWARE = [
+    "plain.middleware.security.SecurityMiddleware",
+    "plain.sessions.middleware.SessionMiddleware",
+    "plain.middleware.common.CommonMiddleware",
+    "plain.csrf.middleware.CsrfViewMiddleware",
+    "plain.auth.middleware.AuthenticationMiddleware",
+    "plain.middleware.clickjacking.XFrameOptionsMiddleware",
+
+    "plain.staff.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_staff` 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 staff toolbar is enabled for every user who `is_staff`.
+
+![Plain staff 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",
+    "/staff/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 [staff 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.staff.impersonate",
+]
+
+MIDDLEWARE = MIDDLEWARE + [
+  "plain.staff.impersonate.ImpersonateMiddleware",
+]
+```
+
+```python
+# urls.py
+urlpatterns = [
+    # ...
+    path("impersonate/", include("plain.staff.impersonate.urls")),
+]
+```
+
+## Settings
+
+By default, all staff users can impersonate other users.
+
+```python
+# settings.py
+IMPERSONATE_ALLOWED = lambda user: user.is_staff
+``` -->

plain-staff/tests/app/settings.py

@@ -21,4 +21,3 @@
 ]
 AUTH_LOGIN_URL = "login"
 AUTH_USER_MODEL = "users.User"
-ASSETS_BACKEND = "plain.assets.storage.StaticFilesStorage"

plain-staff/tests/app/urls.py

@@ -1,3 +1,4 @@
+import plain.assets.urls
 import plain.staff.urls
 from plain.urls import include, path
 from plain.views import View
@@ -15,6 +16,7 @@ def get(self):
 
 urlpatterns = [
     path("staff/", include(plain.staff.urls)),
+    path("assets/", include(plain.assets.urls)),
     path("login/", LoginView, name="login"),
     path("logout/", LogoutView, name="logout"),
 ]

plain/LICENSE

@@ -59,27 +59,3 @@ 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.
-
-
-## This package contains code forked from github.com/evansd/whitenoise
-
-The MIT License (MIT)
-
-Copyright (c) 2013 David Evans
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.