plain 0.48.0__tar.gz → 0.50.0__tar.gz

{plain-0.48.0 → plain-0.50.0}/.gitignore

@@ -6,9 +6,6 @@ __pycache__
 *.DS_Store
 .coverage
 
-# Personal workspace
-/*.code-workspace
-
 # Test apps
 plain*/tests/.plain
 

{plain-0.48.0 → plain-0.50.0}/PKG-INFO

@@ -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.50.0/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-0.48.0 → plain-0.50.0}/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-0.48.0 → plain-0.50.0}/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-0.50.0/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-0.48.0 → plain-0.50.0}/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-0.48.0 → plain-0.50.0}/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-0.48.0 → plain-0.50.0}/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-0.48.0 → plain-0.50.0}/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-0.48.0 → plain-0.50.0}/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 → plain-0.50.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain"
-version = "0.48.0"
+version = "0.50.0"
 description = "A web framework for building products with Python."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 readme = "README.md"

{plain-0.48.0 → plain-0.50.0}/tests/test_cli.py

@@ -15,3 +15,11 @@ def test_plain_cli_build():
     result = runner.invoke(cli, ["build"], prog_name="plain")
     assert result.exit_code == 0
     assert "Compiled 0 assets into 0 files" in result.output
+
+
+def test_plain_help_command():
+    runner = CliRunner()
+    result = runner.invoke(cli, ["help"], prog_name="plain")
+    assert result.exit_code == 0
+    assert "Usage: plain build" in result.output
+    assert "Usage: plain shell" in result.output