plain 0.35.0__py3-none-any.whl → 0.37.0__py3-none-any.whl

plain/README.md

@@ -12,55 +12,55 @@ To quickly get started with Plain, visit [plainframework.com/start/](https://pla
 
 The `plain` package includes everything you need to start handling web requests with Python:
 
-- [assets](assets/README.md) - Serve static files and assets.
-- [cli](cli/README.md) - The `plain` CLI, powered by Click.
-- [csrf](csrf/README.md) - Cross-Site Request Forgery protection.
-- [forms](forms/README.md) - HTML forms and form validation.
-- [http](http/README.md) - HTTP request and response handling.
-- [logs](logs/README.md) - Logging configuration and utilities.
-- [preflight](preflight/README.md) - Preflight checks for your app.
-- [runtime](runtime/README.md) - Runtime settings and configuration.
-- [templates](templates/README.md) - Jinja2 templates and rendering.
-- [test](test/README.md) - Test utilities and fixtures.
-- [urls](urls/README.md) - URL routing and request dispatching.
-- [views](views/README.md) - Class-based views and request handlers.
+- [assets](./assets/README.md) - Serve static files and assets.
+- [cli](./cli/README.md) - The `plain` CLI, powered by Click.
+- [csrf](./csrf/README.md) - Cross-Site Request Forgery protection.
+- [forms](./forms/README.md) - HTML forms and form validation.
+- [http](./http/README.md) - HTTP request and response handling.
+- [logs](./logs/README.md) - Logging configuration and utilities.
+- [preflight](./preflight/README.md) - Preflight checks for your app.
+- [runtime](./runtime/README.md) - Runtime settings and configuration.
+- [templates](./templates/README.md) - Jinja2 templates and rendering.
+- [test](./test/README.md) - Test utilities and fixtures.
+- [urls](./urls/README.md) - URL routing and request dispatching.
+- [views](./views/README.md) - Class-based views and request handlers.
 
 ## Foundational Packages
 
-- [plain.models](/plain-models/README.md) - Define and interact with your database models.
-- [plain.cache](/plain-cache/README.md) - A database-driven general purpose cache.
-- [plain.email](/plain-email/README.md) - Send emails with SMTP or custom backends.
-- [plain.sessions](/plain-sessions/README.md) - User sessions and cookies.
-- [plain.worker](/plain-worker/README.md) - Backgrounb jobs stored in the database.
-- [plain.api](/plain-api/README.md) - Build APIs with Plain views.
+- [plain.models](/plain-models/plain/models/README.md) - Define and interact with your database models.
+- [plain.cache](/plain-cache/plain/cache/README.md) - A database-driven general purpose cache.
+- [plain.email](/plain-email/plain/email/README.md) - Send emails with SMTP or custom backends.
+- [plain.sessions](/plain-sessions/plain/sessions/README.md) - User sessions and cookies.
+- [plain.worker](/plain-worker/plain/worker/README.md) - Backgrounb jobs stored in the database.
+- [plain.api](/plain-api/plain/api/README.md) - Build APIs with Plain views.
 
 ## Auth Packages
 
-- [plain.auth](/plain-auth/README.md) - User authentication and authorization.
-- [plain.oauth](/plain-oauth/README.md) - OAuth authentication and API access.
-- [plain.passwords](/plain-passwords/README.md) - Password-based login and registration.
-- [plain.loginlink](/plain-loginlink/README.md) - Login links for passwordless authentication.
+- [plain.auth](/plain-auth/plain/auth/README.md) - User authentication and authorization.
+- [plain.oauth](/plain-oauth/plain/oauth/README.md) - OAuth authentication and API access.
+- [plain.passwords](/plain-passwords/plain/passwords/README.md) - Password-based login and registration.
+- [plain.loginlink](/plain-loginlink/plain/loginlink/README.md) - Login links for passwordless authentication.
 
 ## Admin Packages
 
-- [plain.admin](/plain-admin/README.md) - An admin interface for back-office tasks.
-- [plain.flags](/plain-flags/README.md) - Feature flags.
-- [plain.support](/plain-support/README.md) - Customer support forms.
-- [plain.redirection](/plain-redirection/README.md) - Redirects managed in the database.
-- [plain.pageviews](/plain-pageviews/README.md) - Basic self-hosted page view tracking and reporting.
+- [plain.admin](/plain-admin/plain/admin/README.md) - An admin interface for back-office tasks.
+- [plain.flags](/plain-flags/plain/flags/README.md) - Feature flags.
+- [plain.support](/plain-support/plain/support/README.md) - Customer support forms.
+- [plain.redirection](/plain-redirection/plain/redirection/README.md) - Redirects managed in the database.
+- [plain.pageviews](/plain-pageviews/plain/pageviews/README.md) - Basic self-hosted page view tracking and reporting.
 
 ## Dev Packages
 
-- [plain.dev](/plain-dev/README.md) - A single command for local development.
-- [plain.pytest](/plain-pytest/README.md) - Pytest fixtures and helpers.
-- [plain.code](/plain-code/README.md) - Code formatting and linting.
-- [plain.tunnel](/plain-tunnel/README.md) - Expose your local server to the internet.
+- [plain.dev](/plain-dev/plain/dev/README.md) - A single command for local development.
+- [plain.pytest](/plain-pytest/plain/pytest/README.md) - Pytest fixtures and helpers.
+- [plain.code](/plain-code/plain/code/README.md) - Code formatting and linting.
+- [plain.tunnel](/plain-tunnel/plain/tunnel/README.md) - Expose your local server to the internet.
 
 ## Frontend Packages
 
-- [plain.tailwind](/plain-tailwind/README.md) - Tailwind CSS integration without Node.js.
-- [plain.htmx](/plain-htmx/README.md) - HTMX integrated into views and templates.
-- [plain.elements](/plain-elements/README.md) - Server-side HTML components.
-- [plain.pages](/plain-pages/README.md) - Static pages with Markdown and Jinja2.
-- [plain.esbuild](/plain-esbuild/README.md) - Simple JavaScript bundling and minification.
-- [plain.vendor](/plain-vendor/README.md) - Vendor JavaScript and CSS libraries.
+- [plain.tailwind](/plain-tailwind/plain/tailwind/README.md) - Tailwind CSS integration without Node.js.
+- [plain.htmx](/plain-htmx/plain/htmx/README.md) - HTMX integrated into views and templates.
+- [plain.elements](/plain-elements/plain/elements/README.md) - Server-side HTML components.
+- [plain.pages](/plain-pages/plain/pages/README.md) - Static pages with Markdown and Jinja2.
+- [plain.esbuild](/plain-esbuild/plain/esbuild/README.md) - Simple JavaScript bundling and minification.
+- [plain.vendor](/plain-vendor/plain/vendor/README.md) - Vendor JavaScript and CSS libraries.

plain/assets/views.py

@@ -254,7 +254,7 @@ class AssetView(View):
 
         if not range_header.startswith("bytes="):
             return Response(
-                status=416, headers=[("Content-Range", f"bytes */{file_size}")]
+                status_code=416, headers=[("Content-Range", f"bytes */{file_size}")]
             )
 
         range_values = range_header.split("=")[1].split("-")
@@ -263,7 +263,7 @@ class AssetView(View):
 
         if start >= file_size:
             return Response(
-                status=416, headers=[("Content-Range", f"bytes */{file_size}")]
+                status_code=416, headers=[("Content-Range", f"bytes */{file_size}")]
             )
 
         end = min(end, file_size - 1)
@@ -272,7 +272,7 @@ class AssetView(View):
             f.seek(start)
             content = f.read(end - start + 1)
 
-        response = StreamingResponse(BytesIO(content), status=206)
+        response = StreamingResponse(BytesIO(content), status_code=206)
         response.headers = self.update_headers(response.headers, path)
         response.headers["Content-Range"] = f"bytes {start}-{end}/{file_size}"
         response.headers["Content-Length"] = str(end - start + 1)

plain/cli/build.py

@@ -0,0 +1,107 @@
+import shutil
+import subprocess
+import sys
+import tomllib
+from importlib.metadata import entry_points
+from pathlib import Path
+
+import click
+
+import plain.runtime
+from plain.assets.compile import compile_assets, get_compiled_path
+
+
+@click.command()
+@click.option(
+    "--keep-original/--no-keep-original",
+    "keep_original",
+    is_flag=True,
+    default=False,
+    help="Keep the original assets",
+)
+@click.option(
+    "--fingerprint/--no-fingerprint",
+    "fingerprint",
+    is_flag=True,
+    default=True,
+    help="Fingerprint the assets",
+)
+@click.option(
+    "--compress/--no-compress",
+    "compress",
+    is_flag=True,
+    default=True,
+    help="Compress the assets",
+)
+def build(keep_original, fingerprint, compress):
+    """Pre-deployment build step (compile assets, css, js, etc.)"""
+
+    if not keep_original and not fingerprint:
+        click.secho(
+            "You must either keep the original assets or fingerprint them.",
+            fg="red",
+            err=True,
+        )
+        sys.exit(1)
+
+    # Run user-defined build commands first
+    pyproject_path = plain.runtime.APP_PATH.parent / "pyproject.toml"
+    if pyproject_path.exists():
+        with pyproject_path.open("rb") as f:
+            pyproject = tomllib.load(f)
+
+        for name, data in (
+            pyproject.get("tool", {})
+            .get("plain", {})
+            .get("build", {})
+            .get("run", {})
+            .items()
+        ):
+            click.secho(f"Running {name} from pyproject.toml", bold=True)
+            result = subprocess.run(data["cmd"], shell=True)
+            print()
+            if result.returncode:
+                click.secho(f"Error in {name} (exit {result.returncode})", fg="red")
+                sys.exit(result.returncode)
+
+    # Then run installed package build steps (like tailwind, typically should run last...)
+    for entry_point in entry_points(group="plain.build"):
+        click.secho(f"Running {entry_point.name}", bold=True)
+        result = entry_point.load()()
+        print()
+
+    # Compile our assets
+    target_dir = get_compiled_path()
+    click.secho(f"Compiling assets to {target_dir}", bold=True)
+    if target_dir.exists():
+        click.secho("(clearing previously compiled assets)")
+        shutil.rmtree(target_dir)
+    target_dir.mkdir(parents=True, exist_ok=True)
+
+    total_files = 0
+    total_compiled = 0
+
+    for url_path, resolved_url_path, compiled_paths in compile_assets(
+        target_dir=target_dir,
+        keep_original=keep_original,
+        fingerprint=fingerprint,
+        compress=compress,
+    ):
+        if url_path == resolved_url_path:
+            click.secho(url_path, bold=True)
+        else:
+            click.secho(url_path, bold=True, nl=False)
+            click.secho(" → ", fg="yellow", nl=False)
+            click.echo(resolved_url_path)
+
+        print("\n".join(f"  {Path(p).relative_to(Path.cwd())}" for p in compiled_paths))
+
+        total_files += 1
+        total_compiled += len(compiled_paths)
+
+    click.secho(
+        f"\nCompiled {total_files} assets into {total_compiled} files", fg="green"
+    )
+
+    # TODO could do a jinja pre-compile here too?
+    # environment.compile_templates() but it needs a target, ignore_errors=False