plain 0.36.0__tar.gz → 0.37.0__tar.gz

plain-0.37.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: plain
+Version: 0.37.0
+Summary: A web framework for building products with Python.
+Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: click>=8.0.0
+Requires-Dist: jinja2>=3.1.2
+Description-Content-Type: text/markdown
+
+# Plain
+
+**Plain is a web framework for building products with Python.**
+
+The core `plain` package provides the backbone of a Python web application (similar to [Flask](https://flask.palletsprojects.com/en/stable/)), while the additional first-party packages can power a more fully-featured database-backed app (similar to [Django](https://www.djangoproject.com/)).
+
+All Plain packages are designed to work together and use [PEP 420](https://peps.python.org/pep-0420/) to share the `plain` namespace.
+
+To quickly get started with Plain, visit [plainframework.com/start/](https://plainframework.com/start/).
+
+## Core Modules
+
+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.
+
+## Foundational Packages
+
+- [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/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/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/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/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-0.37.0/plain/README.md

@@ -0,0 +1,66 @@
+# Plain
+
+**Plain is a web framework for building products with Python.**
+
+The core `plain` package provides the backbone of a Python web application (similar to [Flask](https://flask.palletsprojects.com/en/stable/)), while the additional first-party packages can power a more fully-featured database-backed app (similar to [Django](https://www.djangoproject.com/)).
+
+All Plain packages are designed to work together and use [PEP 420](https://peps.python.org/pep-0420/) to share the `plain` namespace.
+
+To quickly get started with Plain, visit [plainframework.com/start/](https://plainframework.com/start/).
+
+## Core Modules
+
+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.
+
+## Foundational Packages
+
+- [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/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/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/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/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-0.36.0 → plain-0.37.0}/plain/cli/scaffold.py

@@ -48,6 +48,6 @@ class {package_name.capitalize()}Router(Router):
         )
 
     click.secho(
-        f'Created {package_dir.relative_to(Path.cwd())}. Make sure to add "{package_name}" to INSTALLED_PACKAGES!',
+        f'Created {package_dir.relative_to(Path.cwd())}. Make sure to add "app.{package_name}" to INSTALLED_PACKAGES!',
         fg="green",
     )

{plain-0.36.0 → plain-0.37.0}/plain/views/objects.py

@@ -7,7 +7,7 @@ from .templates import TemplateView
 
 
 class ObjectTemplateViewMixin:
-    context_object_name = "object"
+    context_object_name = ""
 
     def get(self) -> Response:
         self.load_object()
@@ -31,7 +31,11 @@ class ObjectTemplateViewMixin:
     def get_template_context(self) -> dict:
         """Insert the single object into the context dict."""
         context = super().get_template_context()  # type: ignore
-        context[self.context_object_name] = self.object
+        context["object"] = (
+            self.object
+        )  # Some templates can benefit by always knowing a primary "object" can be present
+        if self.context_object_name:
+            context[self.context_object_name] = self.object
         return context
 
 
@@ -163,7 +167,7 @@ class ListView(TemplateView):
     rendered by a template.
     """
 
-    context_object_name = "objects"
+    context_object_name = ""
 
     def get(self) -> Response:
         self.objects = self.get_objects()
@@ -177,5 +181,7 @@ class ListView(TemplateView):
     def get_template_context(self) -> dict:
         """Insert the single object into the context dict."""
         context = super().get_template_context()  # type: ignore
-        context[self.context_object_name] = self.objects
+        context["objects"] = self.objects
+        if self.context_object_name:
+            context[self.context_object_name] = self.objects
         return context

{plain-0.36.0 → plain-0.37.0}/pyproject.toml

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

plain-0.36.0/PKG-INFO

@@ -1,77 +0,0 @@
-Metadata-Version: 2.4
-Name: plain
-Version: 0.36.0
-Summary: A web framework for building products with Python.
-Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
-License-File: LICENSE
-Requires-Python: >=3.11
-Requires-Dist: click>=8.0.0
-Requires-Dist: jinja2>=3.1.2
-Description-Content-Type: text/markdown
-
-# Plain
-
-**Plain is a web framework for building products with Python.**
-
-The core `plain` package provides the backbone of a Python web application (similar to [Flask](https://flask.palletsprojects.com/en/stable/)), while the additional first-party packages can power a more fully-featured database-backed app (similar to [Django](https://www.djangoproject.com/)).
-
-All Plain packages are designed to work together and use [PEP 420](https://peps.python.org/pep-0420/) to share the `plain` namespace.
-
-To quickly get started with Plain, visit [plainframework.com/start/](https://plainframework.com/start/).
-
-## Core Modules
-
-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.
-
-## 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.
-
-## 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.
-
-## 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.
-
-## 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.
-
-## 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-0.36.0/plain/README.md

@@ -1,66 +0,0 @@
-# Plain
-
-**Plain is a web framework for building products with Python.**
-
-The core `plain` package provides the backbone of a Python web application (similar to [Flask](https://flask.palletsprojects.com/en/stable/)), while the additional first-party packages can power a more fully-featured database-backed app (similar to [Django](https://www.djangoproject.com/)).
-
-All Plain packages are designed to work together and use [PEP 420](https://peps.python.org/pep-0420/) to share the `plain` namespace.
-
-To quickly get started with Plain, visit [plainframework.com/start/](https://plainframework.com/start/).
-
-## Core Modules
-
-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.
-
-## 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.
-
-## 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.
-
-## 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.
-
-## 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.
-
-## 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.