plain 0.48.0__py3-none-any.whl → 0.50.0__py3-none-any.whl

plain/CHANGELOG.md

@@ -0,0 +1,33 @@
+# plain changelog
+
+## [0.50.0](https://github.com/dropseed/plain/releases/plain@0.50.0) (2025-06-23)
+
+### What's changed
+
+- The URL inspection command has moved; run `plain urls list` instead of the old `plain urls` command ([6146fcb](https://github.com/dropseed/plain/commit/6146fcba536c551277d625bd750c385431ea18eb))
+- `plain preflight` gains a simpler `--database` flag that enables database checks for your default database. The previous behaviour that accepted one or more database aliases has been removed ([d346d81](https://github.com/dropseed/plain/commit/d346d81567d2cc45bbed93caba18a195de10c572))
+- Settings overhaul: use a single `DATABASE` setting instead of `DATABASES`/`DATABASE_ROUTERS` ([d346d81](https://github.com/dropseed/plain/commit/d346d81567d2cc45bbed93caba18a195de10c572))
+
+### Upgrade instructions
+
+- Update any scripts or documentation that call `plain urls …`:
+  - Replace `plain urls --flat` with `plain urls list --flat`
+- If you invoke preflight checks in CI or locally:
+  - Replace `plain preflight --database <alias>` (or multiple aliases) with the new boolean flag: `plain preflight --database`
+- In `settings.py` migrate to the new database configuration:
+  ```python
+  # Before
+  DATABASES = {
+      "default": {
+          "ENGINE": "plain.backends.sqlite3",
+          "NAME": BASE_DIR / "db.sqlite3",
+      }
+  }
+
+  # After
+  DATABASE = {
+      "ENGINE": "plain.backends.sqlite3",
+      "NAME": BASE_DIR / "db.sqlite3",
+  }
+  ```
+  Remove any `DATABASES` and `DATABASE_ROUTERS` settings – they are no longer read.

plain/cli/README.md

@@ -30,6 +30,12 @@ Run a Python script in the context of your app.
 
 View the runtime value of a named setting.
 
+### `plain help`
+
+Print help for all available commands and subcommands.
+Each command's help output is prefixed with the full command name for
+readability.
+
 ### `plain shell`
 
 Open a Python shell with the Plain loaded.
@@ -46,7 +52,7 @@ __all__ = [
 ]
 ```
 
-### `plain urls`
+### `plain urls list`
 
 List all the URL patterns in your app.
 

plain/cli/core.py

@@ -10,6 +10,7 @@ from .build import build
 from .chores import chores
 from .docs import docs
 from .formatting import PlainContext
+from .help import help_cmd
 from .preflight import preflight_checks
 from .registry import cli_registry
 from .scaffold import create
@@ -34,6 +35,7 @@ plain_cli.add_command(urls)
 plain_cli.add_command(setting)
 plain_cli.add_command(shell)
 plain_cli.add_command(run)
+plain_cli.add_command(help_cmd)
 
 
 class CLIRegistryGroup(click.Group):

plain/cli/help.py

@@ -0,0 +1,27 @@
+import click
+from click.core import MultiCommand
+
+
+@click.command("help")
+@click.pass_context
+def help_cmd(ctx):
+    """Show help for all commands and subcommands."""
+
+    root = ctx.parent.command
+    info_name = ctx.parent.info_name or "plain"
+
+    def print_help(cmd, prog, parent=None):
+        sub_ctx = click.Context(cmd, info_name=prog, parent=parent)
+
+        title = sub_ctx.command_path
+        click.secho(title, fg="green", bold=True)
+        click.secho("-" * len(title), fg="green")
+        click.echo(sub_ctx.get_help())
+
+        if isinstance(cmd, MultiCommand):
+            for name in cmd.list_commands(sub_ctx):
+                click.echo()
+                sub_cmd = cmd.get_command(sub_ctx, name)
+                print_help(sub_cmd, name, sub_ctx)
+
+    print_help(root, info_name)

plain/cli/preflight.py

@@ -19,11 +19,10 @@ from plain.packages import packages_registry
 )
 @click.option(
     "--database",
-    "databases",
-    multiple=True,
-    help="Run database related checks against these aliases.",
+    is_flag=True,
+    help="Run database related checks as part of preflight.",
 )
-def preflight_checks(package_label, deploy, fail_level, databases):
+def preflight_checks(package_label, deploy, fail_level, database):
     """
     Use the system check framework to validate entire Plain project.
     Raise CommandError for any serious message (error or critical errors).
@@ -42,7 +41,7 @@ def preflight_checks(package_label, deploy, fail_level, databases):
     all_issues = preflight.run_checks(
         package_configs=package_configs,
         include_deployment_checks=include_deployment_checks,
-        databases=databases,
+        database=database,
     )
 
     header, body, footer = "", "", ""

plain/cli/urls.py

@@ -3,9 +3,15 @@ import sys
 import click
 
 
-@click.command()
+@click.group()
+def urls():
+    """URL related commands"""
+    pass
+
+
+@urls.command("list")
 @click.option("--flat", is_flag=True, help="List all URLs in a flat list")
-def urls(flat):
+def list_urls(flat):
     """Print all URL patterns under settings.URLS_ROUTER"""
     from plain.runtime import settings
     from plain.urls import URLResolver, get_resolver

plain/preflight/registry.py

@@ -42,7 +42,7 @@ class CheckRegistry:
         self,
         package_configs=None,
         include_deployment_checks=False,
-        databases=None,
+        database=False,
     ):
         """
         Run all registered checks and return list of Errors and Warnings.
@@ -51,7 +51,7 @@ class CheckRegistry:
         checks = self.get_checks(include_deployment_checks)
 
         for check in checks:
-            new_errors = check(package_configs=package_configs, databases=databases)
+            new_errors = check(package_configs=package_configs, database=database)
             if not is_iterable(new_errors):
                 raise TypeError(
                     f"The function {check!r} did not return a list. All functions "

plain/runtime/README.md

@@ -79,28 +79,21 @@ from os import environ
 
 from . import database_url
 
-# Make DATABASES a required setting
-DATABASES: dict
+# Make DATABASE a required setting
+DATABASE: dict
 
-# Automatically configure DATABASES if a DATABASE_URL was given in the environment
+# Automatically configure DATABASE if a DATABASE_URL was given in the environment
 if "DATABASE_URL" in environ:
-    DATABASES = {
-        "default": database_url.parse_database_url(
-            environ["DATABASE_URL"],
-            # Enable persistent connections by default
-            conn_max_age=int(environ.get("DATABASE_CONN_MAX_AGE", 600)),
-            conn_health_checks=environ.get(
-                "DATABASE_CONN_HEALTH_CHECKS", "true"
-            ).lower()
-            in [
-                "true",
-                "1",
-            ],
-        )
-    }
-
-# Classes used to implement DB routing behavior.
-DATABASE_ROUTERS = []
+    DATABASE = database_url.parse_database_url(
+        environ["DATABASE_URL"],
+        # Enable persistent connections by default
+        conn_max_age=int(environ.get("DATABASE_CONN_MAX_AGE", 600)),
+        conn_health_checks=environ.get("DATABASE_CONN_HEALTH_CHECKS", "true").lower()
+        in [
+            "true",
+            "1",
+        ],
+    )
 ```
 
 ### .env files

plain/test/client.py

@@ -6,7 +6,7 @@ from http.cookies import SimpleCookie
 from io import BytesIO, IOBase
 from urllib.parse import unquote_to_bytes, urljoin, urlparse, urlsplit
 
-from plain.http import HttpHeaders, HttpRequest, QueryDict
+from plain.http import HttpHeaders, QueryDict
 from plain.internal import internalcode
 from plain.internal.handlers.base import BaseHandler
 from plain.internal.handlers.wsgi import WSGIRequest
@@ -775,57 +775,20 @@ class Client(RequestFactory):
     @property
     def session(self):
         """Return the current session variables."""
-        from plain.sessions import SessionStore
+        from plain.sessions.test import get_client_session
 
-        cookie = self.cookies.get(settings.SESSION_COOKIE_NAME)
-        if cookie:
-            return SessionStore(cookie.value)
-        session = SessionStore()
-        session.save()
-        self.cookies[settings.SESSION_COOKIE_NAME] = session.session_key
-        return session
+        return get_client_session(self)
 
     def force_login(self, user):
-        self._login(user)
+        from plain.auth.test import login_client
 
-    def _login(self, user):
-        from plain.auth import login
-        from plain.sessions import SessionStore
-
-        # Create a fake request to store login details.
-        request = HttpRequest()
-        if self.session:
-            request.session = self.session
-        else:
-            request.session = SessionStore()
-        login(request, user)
-        # Save the session values.
-        request.session.save()
-        # Set the cookie to represent the session.
-        session_cookie = settings.SESSION_COOKIE_NAME
-        self.cookies[session_cookie] = request.session.session_key
-        cookie_data = {
-            "max-age": None,
-            "path": "/",
-            "domain": settings.SESSION_COOKIE_DOMAIN,
-            "secure": settings.SESSION_COOKIE_SECURE or None,
-            "expires": None,
-        }
-        self.cookies[session_cookie].update(cookie_data)
+        login_client(self, user)
 
     def logout(self):
         """Log out the user by removing the cookies and session object."""
-        from plain.auth import get_user, logout
-        from plain.sessions import SessionStore
+        from plain.auth.test import logout_client
 
-        request = HttpRequest()
-        if self.session:
-            request.session = self.session
-            request.user = get_user(request)
-        else:
-            request.session = SessionStore()
-        logout(request)
-        self.cookies = SimpleCookie()
+        logout_client(self)
 
     def _parse_json(self, response, **extra):
         if not hasattr(response, "_json"):

{plain-0.48.0.dist-info → plain-0.50.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain
-Version: 0.48.0
+Version: 0.50.0
 Summary: A web framework for building products with Python.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE

{plain-0.48.0.dist-info → plain-0.50.0.dist-info}/RECORD

@@ -1,3 +1,4 @@
+plain/CHANGELOG.md,sha256=Bl0GLzelbqK3Tyg-dAGBcHG49JwXtH3g6GHFCl-LEpk,1554
 plain/README.md,sha256=gik6DBZcJAITcm4WRq_L53AxkjY45eQLafyTCSf0CKE,3986
 plain/__main__.py,sha256=GK39854Lc_LO_JP8DzY9Y2MIQ4cQEl7SXFJy244-lC8,110
 plain/debug.py,sha256=abPkJY4aSbBYGEYSZST_ZY3ohXPGDdz9uWQBYRqfd3M,730
@@ -17,21 +18,22 @@ plain/assets/views.py,sha256=T_0Qh6v9qBerEBYbhToigwOzsij-x1z_R-1zETQcIh0,9447
 plain/chores/README.md,sha256=Da8Nw8ZF7PlAE_iVb0AqJGbLOu0F6HC0cj1K451KBak,1946
 plain/chores/__init__.py,sha256=r9TXtQCH-VbvfnIJ5F8FxgQC35GRWFOfmMZN3q9niLg,67
 plain/chores/registry.py,sha256=V3WjuekRI22LFvJbqSkUXQtiOtuE2ZK8gKV1TRvxRUI,1866
-plain/cli/README.md,sha256=ompPcgzY2Fdpm579ITmCpFIaZIsiXYbfD61mqkq312M,1860
+plain/cli/README.md,sha256=GzBry6mEilhM80SfVUg02ydGwAk0m-s6FAqQR1nRsMM,2022
 plain/cli/__init__.py,sha256=6w9T7K2WrPwh6DcaMb2oNt_CWU6Bc57nUTO2Bt1p38Y,63
 plain/cli/build.py,sha256=dKUYBNegvb6QNckR7XZ7CJJtINwZcmDvbUdv2dWwjf8,3226
 plain/cli/chores.py,sha256=xXSSFvr8T5jWfLWqe6E8YVMw1BkQxyOHHVuY0x9RH0A,2412
-plain/cli/core.py,sha256=sy5otyN5jNOHkcy1EXISB7iMr1itp0rzmBSnEXYGe2k,2866
+plain/cli/core.py,sha256=h8gjeBYQzYTzpmeDMAJTdVDOEoNCNcvnxml-KIsiRPo,2925
 plain/cli/docs.py,sha256=2CpTv5k-TNWf593tPiglvUVXWBGdfPmbGf8vl5AfJwU,8995
 plain/cli/formatting.py,sha256=1hZH13y1qwHcU2K2_Na388nw9uvoeQH8LrWL-O9h8Yc,2207
-plain/cli/preflight.py,sha256=NKyYjcoDjigzfJIDhf7A7degYadaUI05Bw7U9OQ73vs,4170
+plain/cli/help.py,sha256=otRSGxOJ5V8JMjpdZ8XYqUbdlYdJvxOMzQroLOWw-l0,801
+plain/cli/preflight.py,sha256=FWFwMZ0W_t8ObTTRMnBmaiGN8PqdEAWgmSEPGDwZFpA,4148
 plain/cli/print.py,sha256=XraUYrgODOJquIiEv78wSCYGRBplHXtXSS9QtFG5hqY,217
 plain/cli/registry.py,sha256=yKVMSDjW8g10nlV9sPXFGJQmhC_U-k4J4kM7N2OQVLA,1467
 plain/cli/scaffold.py,sha256=mcywA9DzfwoBSqWl5-Zpgcy1mTNUGEgdvoxXUrGcEVk,1351
 plain/cli/settings.py,sha256=9cx4bue664I2P7kUedlf4YhCPB0tSKSE4Q8mGyzEv2o,1995
 plain/cli/shell.py,sha256=iIwvlTdTBjLBBUdXMAmIRWSoynszOZI79-mrBg4RegU,1373
 plain/cli/startup.py,sha256=wLaFuyUb4ewWhtehBCGicrRCXIIGCRbeCT3ce9hUv-A,1022
-plain/cli/urls.py,sha256=CS9NFpwZBWveAR8F3YsoUNySDEK_PwF73oSgLDfkOdI,3776
+plain/cli/urls.py,sha256=7FOvLjfV1GsYKnb7SGlIgEfchQcrkWdYU1nY6aazGBI,3855
 plain/cli/utils.py,sha256=VwlIh0z7XxzVV8I3qM2kZo07fkJFPoeeVZa1ODG616k,258
 plain/csrf/README.md,sha256=nxCpPk1HF5eAM-7paxg9D-9RVCU9jXsSPAVHkJvA_DU,717
 plain/csrf/middleware.py,sha256=U3B9R7ciO_UAf7O3jdNtVu6QZ_3Yrm8isRdnW6bVKX4,17401
@@ -78,10 +80,10 @@ plain/preflight/README.md,sha256=9fE0Ql2JNd3CI420eg1sP_xmaim-6Ejlzi_hfk3tVS0,151
 plain/preflight/__init__.py,sha256=j4-yPnrM5hmjumrdkBLOQjFHzRHpA6wCjiFpMNBjIqY,619
 plain/preflight/files.py,sha256=D_pBSwRXpXy2-3FWywweozuxrhIaR8w5hpPA2d6XMPs,522
 plain/preflight/messages.py,sha256=B6VyXzu7HTJHaPVK4G1L_1HVHG87CT7JPtcDk8QYSeE,2322
-plain/preflight/registry.py,sha256=wHLq6LSMkKunkxElBmNwzMzQx3tc6OGYeKyOOi0tuyQ,2333
+plain/preflight/registry.py,sha256=vcqzaE1MIneNL_ydKPy_1zrSThnzsrWARSClLCJ-4b8,2331
 plain/preflight/security.py,sha256=oxUZBp2M0bpBfUoLYepIxoex2Y90nyjlrL8XU8UTHYY,2438
 plain/preflight/urls.py,sha256=cQ-WnFa_5oztpKdtwhuIGb7pXEml__bHsjs1SWO2YNI,1468
-plain/runtime/README.md,sha256=yPcrJKnFEqkrb0KlhLZi2VInV-LCl6ENOZs7mOHlhi0,4753
+plain/runtime/README.md,sha256=1h30eRTg5-lY-G7GF_4TdUiUcOLVzKR15mSrmyeU8eI,4584
 plain/runtime/__init__.py,sha256=8GtvKROf3HUCtneDYXTbEioPcCtwnV76dP57n2PnjuE,2343
 plain/runtime/global_settings.py,sha256=MpJ6vtBMO2EYALaKXrtgcGoxLh9Y549zwwErC5D5K7I,5343
 plain/runtime/user_settings.py,sha256=OzMiEkE6ZQ50nxd1WIqirXPiNuMAQULklYHEzgzLWgA,11027
@@ -100,7 +102,7 @@ plain/templates/jinja/filters.py,sha256=t_u8BkWtEpJFLbLywONxWKrenSzOvDJhfOLwlZiX
 plain/templates/jinja/globals.py,sha256=VMpuMZvwWOmb5MbzKK-ox-QEX_WSsXFxq0mm8biJgaU,558
 plain/test/README.md,sha256=fv4YzziU2QxgcNHSgv7aDUO45sDOofVuCNrV1NPbWzo,1106
 plain/test/__init__.py,sha256=MhNHtp7MYBl9kq-pMRGY11kJ6kU1I6vOkjNkit1TYRg,94
-plain/test/client.py,sha256=lqzOf8EJo_u54dW_oiPy0m5mW-Nt3-CWyrBh9_MJnms,26930
+plain/test/client.py,sha256=XjLjkeDl1rQRaFoeiCvvD5GXfxIxpuic2OnxjoX05tA,25573
 plain/test/encoding.py,sha256=YJBOIE-BQRA5yl4zHnQy-9l67mJDTFmfy1DQXK0Wk-Q,3199
 plain/test/exceptions.py,sha256=b-GHicg87Gh73W3g8QGWuSHi9PrQFVsxgWvEXDLt8gQ,290
 plain/urls/README.md,sha256=ijFGmrkUY9buBqO_i1GZaN3V55vl9xwEADtHOx_ZHPY,3724
@@ -145,8 +147,8 @@ plain/views/forms.py,sha256=ESZOXuo6IeYixp1RZvPb94KplkowRiwO2eGJCM6zJI0,2400
 plain/views/objects.py,sha256=GGbcfg_9fPZ-PiaBwIHG2e__8GfWDR7JQtQ15wTyiHg,5970
 plain/views/redirect.py,sha256=daq2cQIkdDF78bt43sjuZxRAyJm_t_SKw6tyPmiXPIc,1985
 plain/views/templates.py,sha256=ivkI7LU7BXDQ0d4Geab96Is4-Cp03KbIntXRT1J8e6I,2139
-plain-0.48.0.dist-info/METADATA,sha256=N4Mvv-2mriZwcXfYBEWMz88pp3Sc4oik88GXI4akoMk,4297
-plain-0.48.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain-0.48.0.dist-info/entry_points.txt,sha256=1Ys2lsSeMepD1vz8RSrJopna0RQfUd951vYvCRsvl6A,45
-plain-0.48.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
-plain-0.48.0.dist-info/RECORD,,
+plain-0.50.0.dist-info/METADATA,sha256=GLcRDpS06XPtx52qLG5bIfrROE3g8CFffLNSz6Mdxt8,4297
+plain-0.50.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain-0.50.0.dist-info/entry_points.txt,sha256=1Ys2lsSeMepD1vz8RSrJopna0RQfUd951vYvCRsvl6A,45
+plain-0.50.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
+plain-0.50.0.dist-info/RECORD,,