pytypehintweb 1.2.0__tar.gz → 1.2.2__tar.gz

pytypehintweb-1.2.2/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: pytypehintweb
+Version: 1.2.2
+Summary: Framework-free browser form layer for pytypehint
+Author: Beltran Offerrall
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/offerrall/pytypehintweb
+Project-URL: Documentation, https://offerrall.github.io/pytypehintweb/
+Project-URL: Repository, https://github.com/offerrall/pytypehintweb
+Project-URL: Issues, https://github.com/offerrall/pytypehintweb/issues
+Keywords: forms,type-hints,dataclasses,schema,web,html
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: JavaScript
+Classifier: Topic :: Software Development :: User Interfaces
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytypehint==1.0.0
+Provides-Extra: demo
+Requires-Dist: fastapi; extra == "demo"
+Requires-Dist: uvicorn; extra == "demo"
+Requires-Dist: python-multipart; extra == "demo"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Dynamic: license-file
+
+# pytypehintweb
+
+Python schemas in. Portable form plans and browser widgets out.
+
+pytypehintweb turns a [pytypehint](https://offerrall.github.io/pytypehint/)
+schema into a self-contained, JSON-serializable form plan, and renders that plan
+in the browser with plain JavaScript widgets: no framework, no build step, no
+npm. The browser side reads plans, not Python, so hand-written plans and plans
+from another backend render the same way.
+
+It is the rendering layer only. Routing, serving, submission and running the
+function stay with the host application, or with
+[func-to-web](https://offerrall.github.io/func-to-web/), which builds the whole
+request cycle on top of it.
+
+```python
+from typing import Annotated
+
+from pytypehint import Label, Min
+from pytypehintweb import plan_of
+
+
+def create_user(
+    username: Annotated[str, Min(3), Label("Username")],
+    age: Annotated[int, Min(0), Label("Age")],
+) -> None:
+    pass
+
+
+plan = plan_of(create_user)  # a JSON-ready dict; compileForm(plan) renders it
+```
+
+The full documentation is at https://offerrall.github.io/pytypehintweb/.
+
+## Documentation
+
+- [Overview](docs/overview.md): what the library does, where it stops, its features and its stability promise.
+- [Getting started](docs/getting-started.md): one complete form, from a Python function to the built result.
+- [Plan contract](docs/plan.md): the plan format, every property, default and invariant.
+- [Python API](docs/python.md): `plan_of()`, `decode()`, `WebConfig` and how each annotation maps to a node.
+- [JavaScript API](docs/javascript.md): `compileForm()`, widgets, reading, accessibility, styling and themes.
+- [Architecture](docs/architecture.md): the layers and which layer owns each rule.
+- [Limitations](docs/limitations.md): what a plan cannot represent and why.
+
+### Maintaining
+
+- [Testing](docs/testing.md): how to run the suites, what they guarantee, and CI and release.

pytypehintweb-1.2.2/README.md

@@ -0,0 +1,47 @@
+# pytypehintweb
+
+Python schemas in. Portable form plans and browser widgets out.
+
+pytypehintweb turns a [pytypehint](https://offerrall.github.io/pytypehint/)
+schema into a self-contained, JSON-serializable form plan, and renders that plan
+in the browser with plain JavaScript widgets: no framework, no build step, no
+npm. The browser side reads plans, not Python, so hand-written plans and plans
+from another backend render the same way.
+
+It is the rendering layer only. Routing, serving, submission and running the
+function stay with the host application, or with
+[func-to-web](https://offerrall.github.io/func-to-web/), which builds the whole
+request cycle on top of it.
+
+```python
+from typing import Annotated
+
+from pytypehint import Label, Min
+from pytypehintweb import plan_of
+
+
+def create_user(
+    username: Annotated[str, Min(3), Label("Username")],
+    age: Annotated[int, Min(0), Label("Age")],
+) -> None:
+    pass
+
+
+plan = plan_of(create_user)  # a JSON-ready dict; compileForm(plan) renders it
+```
+
+The full documentation is at https://offerrall.github.io/pytypehintweb/.
+
+## Documentation
+
+- [Overview](docs/overview.md): what the library does, where it stops, its features and its stability promise.
+- [Getting started](docs/getting-started.md): one complete form, from a Python function to the built result.
+- [Plan contract](docs/plan.md): the plan format, every property, default and invariant.
+- [Python API](docs/python.md): `plan_of()`, `decode()`, `WebConfig` and how each annotation maps to a node.
+- [JavaScript API](docs/javascript.md): `compileForm()`, widgets, reading, accessibility, styling and themes.
+- [Architecture](docs/architecture.md): the layers and which layer owns each rule.
+- [Limitations](docs/limitations.md): what a plan cannot represent and why.
+
+### Maintaining
+
+- [Testing](docs/testing.md): how to run the suites, what they guarantee, and CI and release.

{pytypehintweb-1.2.0 → pytypehintweb-1.2.2}/pyproject.toml

@@ -29,6 +29,7 @@ classifiers = [
 
 [project.urls]
 Homepage = "https://github.com/offerrall/pytypehintweb"
+Documentation = "https://offerrall.github.io/pytypehintweb/"
 Repository = "https://github.com/offerrall/pytypehintweb"
 Issues = "https://github.com/offerrall/pytypehintweb/issues"
 

{pytypehintweb-1.2.0 → pytypehintweb-1.2.2}/src/pytypehintweb/__init__.py

@@ -6,7 +6,7 @@ from pytypehintweb.types import COLOR_PATTERN, EMAIL_PATTERN, Color, Email
 
 STATIC = Path(__file__).parent / "static"
 
-__version__ = "1.2.0"
+__version__ = "1.2.2"
 
 __all__ = [
     "plan_of",

pytypehintweb-1.2.2/src/pytypehintweb.egg-info/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: pytypehintweb
+Version: 1.2.2
+Summary: Framework-free browser form layer for pytypehint
+Author: Beltran Offerrall
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/offerrall/pytypehintweb
+Project-URL: Documentation, https://offerrall.github.io/pytypehintweb/
+Project-URL: Repository, https://github.com/offerrall/pytypehintweb
+Project-URL: Issues, https://github.com/offerrall/pytypehintweb/issues
+Keywords: forms,type-hints,dataclasses,schema,web,html
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: JavaScript
+Classifier: Topic :: Software Development :: User Interfaces
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytypehint==1.0.0
+Provides-Extra: demo
+Requires-Dist: fastapi; extra == "demo"
+Requires-Dist: uvicorn; extra == "demo"
+Requires-Dist: python-multipart; extra == "demo"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Dynamic: license-file
+
+# pytypehintweb
+
+Python schemas in. Portable form plans and browser widgets out.
+
+pytypehintweb turns a [pytypehint](https://offerrall.github.io/pytypehint/)
+schema into a self-contained, JSON-serializable form plan, and renders that plan
+in the browser with plain JavaScript widgets: no framework, no build step, no
+npm. The browser side reads plans, not Python, so hand-written plans and plans
+from another backend render the same way.
+
+It is the rendering layer only. Routing, serving, submission and running the
+function stay with the host application, or with
+[func-to-web](https://offerrall.github.io/func-to-web/), which builds the whole
+request cycle on top of it.
+
+```python
+from typing import Annotated
+
+from pytypehint import Label, Min
+from pytypehintweb import plan_of
+
+
+def create_user(
+    username: Annotated[str, Min(3), Label("Username")],
+    age: Annotated[int, Min(0), Label("Age")],
+) -> None:
+    pass
+
+
+plan = plan_of(create_user)  # a JSON-ready dict; compileForm(plan) renders it
+```
+
+The full documentation is at https://offerrall.github.io/pytypehintweb/.
+
+## Documentation
+
+- [Overview](docs/overview.md): what the library does, where it stops, its features and its stability promise.
+- [Getting started](docs/getting-started.md): one complete form, from a Python function to the built result.
+- [Plan contract](docs/plan.md): the plan format, every property, default and invariant.
+- [Python API](docs/python.md): `plan_of()`, `decode()`, `WebConfig` and how each annotation maps to a node.
+- [JavaScript API](docs/javascript.md): `compileForm()`, widgets, reading, accessibility, styling and themes.
+- [Architecture](docs/architecture.md): the layers and which layer owns each rule.
+- [Limitations](docs/limitations.md): what a plan cannot represent and why.
+
+### Maintaining
+
+- [Testing](docs/testing.md): how to run the suites, what they guarantee, and CI and release.

pytypehintweb-1.2.0/PKG-INFO

@@ -1,193 +0,0 @@
-Metadata-Version: 2.4
-Name: pytypehintweb
-Version: 1.2.0
-Summary: Framework-free browser form layer for pytypehint
-Author: Beltran Offerrall
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/offerrall/pytypehintweb
-Project-URL: Repository, https://github.com/offerrall/pytypehintweb
-Project-URL: Issues, https://github.com/offerrall/pytypehintweb/issues
-Keywords: forms,type-hints,dataclasses,schema,web,html
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: JavaScript
-Classifier: Topic :: Software Development :: User Interfaces
-Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
-Classifier: Typing :: Typed
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pytypehint==1.0.0
-Provides-Extra: demo
-Requires-Dist: fastapi; extra == "demo"
-Requires-Dist: uvicorn; extra == "demo"
-Requires-Dist: python-multipart; extra == "demo"
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: mypy; extra == "test"
-Dynamic: license-file
-
-# pytypehintweb 1.2.0
-
-[![PyPI version](https://img.shields.io/pypi/v/pytypehintweb.svg)](https://pypi.org/project/pytypehintweb/)
-[![Python](https://img.shields.io/pypi/pyversions/pytypehintweb.svg)](https://pypi.org/project/pytypehintweb/)
-[![License](https://img.shields.io/pypi/l/pytypehintweb.svg)](LICENSE)
-
-Python schemas in. Portable form plans and browser widgets out.
-
-`pytypehintweb` is a framework-free browser form layer for
-[`pytypehint`](https://github.com/offerrall/pytypehint). It converts compiled
-Python type schemas into self-contained, JSON-serializable form plans and
-renders them with plain JavaScript widgets. The browser runtime also consumes
-hand-written plans or plans from another backend, so Python is not required at
-render time. Everything around the form — routing, static-file delivery,
-authentication, submission, function execution — belongs to the host
-application. (For the whole request/response cycle instead of the rendering
-layer, see [FuncToWeb](https://github.com/offerrall/FuncToWeb).)
-
-The public API — `plan_of()`, `decode()`, `WebConfig`, `STATIC` and the plan's
-own `v: 1` contract — is settled, and a breaking change to any of them belongs
-to a major release. Internals carry no such promise: 1.1.0 replaced most of
-`decode()` with a call into the core, and that kind of change is expected.
-
-## Features
-
-- Self-contained, JSON-serializable plans from plain functions, dataclass types
-  or compiled `Signature`/`Struct` schemas — and hand-written plans need no
-  Python.
-- Framework-free browser runtime (plain HTML, CSS and JS modules), with widgets
-  usable directly or from a plan; browser files ship inside the Python package
-  under `pytypehintweb.STATIC`.
-- Optional stylesheet scoped to a `.pth-root` container, with a light/dark theme
-  that follows the system or is forced with `data-pth-theme` — pure CSS, no
-  theme JavaScript and no flash. Its icons are plain `.svg` files served beside
-  it, so no `img-src data:` is needed.
-- `str`, `int`, `float`, `date`, `time`, `bool` and `enum` composing through lists,
-  optional fields, unions and nested dataclasses, with constraints, static choices,
-  integer sliders, and configurable validation messages and labels.
-- `file` fields (single, optional or `list[File]`, and inside dataclasses) that
-  mint an upload reference the host redeems through its own channel, and that
-  accept an existing reference as a plan default or through `setValue()`.
-- Centralized plan normalization and validation before any widget is built, and
-  `plain` / `inline` / `wrapped` union transport.
-- Plan text is always rendered as text, never parsed as markup.
-
-## Installation
-
-```bash
-pip install pytypehintweb            # library
-pip install "pytypehintweb[demo]"    # + the local demo (pytypehintweb-demo)
-```
-
-```bash
-# Demo with all widgets, served by a local HTTP server on port 8000:
-pytypehintweb-demo
-```
-
-There is no npm package: the browser modules live under `pytypehintweb.STATIC`
-and can be served by any static-file mount.
-
-## Quick start
-
-```python
-from typing import Annotated
-
-from pytypehint import Label, Min
-from pytypehintweb import plan_of
-
-
-def create_user(
-    username: Annotated[str, Min(3), Label("Username")],
-    age: Annotated[int, Min(0), Label("Age")],
-) -> None:
-    pass
-
-
-plan = plan_of(create_user)
-```
-
-`plan_of()` returns ordinary Python dictionaries and lists — a single, fully
-expanded, self-contained document where every non-conditional property is present
-with an explicit value (`default` appears exactly when `hasDefault` is true),
-carrying a top-level `"v": 1`:
-
-```json
-{
-  "v": 1,
-  "kind": "form",
-  "name": "create_user",
-  "description": null,
-  "fields": [
-    {
-      "name": "username",
-      "label": "Username",
-      "description": null,
-      "optional": false,
-      "enabled": true,
-      "hasDefault": false,
-      "node": {
-        "kind": "str",
-        "options": {
-          "minLength": 3,
-          "maxLength": null,
-          "pattern": null,
-          "patternMessage": "Invalid format",
-          "minMessage": "Must contain at least {value} characters",
-          "maxMessage": "Must contain at most {value} characters",
-          "placeholder": null,
-          "password": false,
-          "rows": null,
-          "choices": null
-        }
-      }
-    },
-    {
-      "name": "age",
-      "label": "Age",
-      "description": null,
-      "optional": false,
-      "enabled": true,
-      "hasDefault": false,
-      "node": {
-        "kind": "int",
-        "options": {
-          "min": 0,
-          "max": null,
-          "multipleOf": null,
-          "step": null,
-          "slider": false,
-          "showValue": false,
-          "placeholder": null,
-          "choices": null,
-          "safeMessage": "Must be a safe integer",
-          "invalidMessage": "Enter a valid integer",
-          "minMessage": "Must be at least {value}",
-          "maxMessage": "Must be at most {value}",
-          "multipleOfMessage": "Must be a multiple of {value}",
-          "increaseLabel": "Increase",
-          "decreaseLabel": "Decrease"
-        }
-      }
-    }
-  ]
-}
-```
-
-Transporting that document to the browser and compiling it with `compileForm()`
-is walked through end to end in [Getting started](docs/getting-started.md).
-
-## Documentation
-
-- [Getting started](docs/getting-started.md) — the end-to-end tutorial.
-- [Plan contract](docs/plan.md) — the plan format, every property and invariant.
-- [Python API](docs/python.md) — `plan_of()`, `WebConfig`, annotation mappings.
-- [JavaScript API](docs/javascript.md) — `compileForm()`, widgets, reading,
-  accessibility, styling and themes.
-- [Architecture](docs/architecture.md) — layers and which layer owns each rule.
-- [Testing](docs/testing.md) — how to run the suites and what they guarantee.
-- [Current limitations](docs/limitations.md).

pytypehintweb-1.2.0/README.md

@@ -1,159 +0,0 @@
-# pytypehintweb 1.2.0
-
-[![PyPI version](https://img.shields.io/pypi/v/pytypehintweb.svg)](https://pypi.org/project/pytypehintweb/)
-[![Python](https://img.shields.io/pypi/pyversions/pytypehintweb.svg)](https://pypi.org/project/pytypehintweb/)
-[![License](https://img.shields.io/pypi/l/pytypehintweb.svg)](LICENSE)
-
-Python schemas in. Portable form plans and browser widgets out.
-
-`pytypehintweb` is a framework-free browser form layer for
-[`pytypehint`](https://github.com/offerrall/pytypehint). It converts compiled
-Python type schemas into self-contained, JSON-serializable form plans and
-renders them with plain JavaScript widgets. The browser runtime also consumes
-hand-written plans or plans from another backend, so Python is not required at
-render time. Everything around the form — routing, static-file delivery,
-authentication, submission, function execution — belongs to the host
-application. (For the whole request/response cycle instead of the rendering
-layer, see [FuncToWeb](https://github.com/offerrall/FuncToWeb).)
-
-The public API — `plan_of()`, `decode()`, `WebConfig`, `STATIC` and the plan's
-own `v: 1` contract — is settled, and a breaking change to any of them belongs
-to a major release. Internals carry no such promise: 1.1.0 replaced most of
-`decode()` with a call into the core, and that kind of change is expected.
-
-## Features
-
-- Self-contained, JSON-serializable plans from plain functions, dataclass types
-  or compiled `Signature`/`Struct` schemas — and hand-written plans need no
-  Python.
-- Framework-free browser runtime (plain HTML, CSS and JS modules), with widgets
-  usable directly or from a plan; browser files ship inside the Python package
-  under `pytypehintweb.STATIC`.
-- Optional stylesheet scoped to a `.pth-root` container, with a light/dark theme
-  that follows the system or is forced with `data-pth-theme` — pure CSS, no
-  theme JavaScript and no flash. Its icons are plain `.svg` files served beside
-  it, so no `img-src data:` is needed.
-- `str`, `int`, `float`, `date`, `time`, `bool` and `enum` composing through lists,
-  optional fields, unions and nested dataclasses, with constraints, static choices,
-  integer sliders, and configurable validation messages and labels.
-- `file` fields (single, optional or `list[File]`, and inside dataclasses) that
-  mint an upload reference the host redeems through its own channel, and that
-  accept an existing reference as a plan default or through `setValue()`.
-- Centralized plan normalization and validation before any widget is built, and
-  `plain` / `inline` / `wrapped` union transport.
-- Plan text is always rendered as text, never parsed as markup.
-
-## Installation
-
-```bash
-pip install pytypehintweb            # library
-pip install "pytypehintweb[demo]"    # + the local demo (pytypehintweb-demo)
-```
-
-```bash
-# Demo with all widgets, served by a local HTTP server on port 8000:
-pytypehintweb-demo
-```
-
-There is no npm package: the browser modules live under `pytypehintweb.STATIC`
-and can be served by any static-file mount.
-
-## Quick start
-
-```python
-from typing import Annotated
-
-from pytypehint import Label, Min
-from pytypehintweb import plan_of
-
-
-def create_user(
-    username: Annotated[str, Min(3), Label("Username")],
-    age: Annotated[int, Min(0), Label("Age")],
-) -> None:
-    pass
-
-
-plan = plan_of(create_user)
-```
-
-`plan_of()` returns ordinary Python dictionaries and lists — a single, fully
-expanded, self-contained document where every non-conditional property is present
-with an explicit value (`default` appears exactly when `hasDefault` is true),
-carrying a top-level `"v": 1`:
-
-```json
-{
-  "v": 1,
-  "kind": "form",
-  "name": "create_user",
-  "description": null,
-  "fields": [
-    {
-      "name": "username",
-      "label": "Username",
-      "description": null,
-      "optional": false,
-      "enabled": true,
-      "hasDefault": false,
-      "node": {
-        "kind": "str",
-        "options": {
-          "minLength": 3,
-          "maxLength": null,
-          "pattern": null,
-          "patternMessage": "Invalid format",
-          "minMessage": "Must contain at least {value} characters",
-          "maxMessage": "Must contain at most {value} characters",
-          "placeholder": null,
-          "password": false,
-          "rows": null,
-          "choices": null
-        }
-      }
-    },
-    {
-      "name": "age",
-      "label": "Age",
-      "description": null,
-      "optional": false,
-      "enabled": true,
-      "hasDefault": false,
-      "node": {
-        "kind": "int",
-        "options": {
-          "min": 0,
-          "max": null,
-          "multipleOf": null,
-          "step": null,
-          "slider": false,
-          "showValue": false,
-          "placeholder": null,
-          "choices": null,
-          "safeMessage": "Must be a safe integer",
-          "invalidMessage": "Enter a valid integer",
-          "minMessage": "Must be at least {value}",
-          "maxMessage": "Must be at most {value}",
-          "multipleOfMessage": "Must be a multiple of {value}",
-          "increaseLabel": "Increase",
-          "decreaseLabel": "Decrease"
-        }
-      }
-    }
-  ]
-}
-```
-
-Transporting that document to the browser and compiling it with `compileForm()`
-is walked through end to end in [Getting started](docs/getting-started.md).
-
-## Documentation
-
-- [Getting started](docs/getting-started.md) — the end-to-end tutorial.
-- [Plan contract](docs/plan.md) — the plan format, every property and invariant.
-- [Python API](docs/python.md) — `plan_of()`, `WebConfig`, annotation mappings.
-- [JavaScript API](docs/javascript.md) — `compileForm()`, widgets, reading,
-  accessibility, styling and themes.
-- [Architecture](docs/architecture.md) — layers and which layer owns each rule.
-- [Testing](docs/testing.md) — how to run the suites and what they guarantee.
-- [Current limitations](docs/limitations.md).

pytypehintweb-1.2.0/src/pytypehintweb.egg-info/PKG-INFO

@@ -1,193 +0,0 @@
-Metadata-Version: 2.4
-Name: pytypehintweb
-Version: 1.2.0
-Summary: Framework-free browser form layer for pytypehint
-Author: Beltran Offerrall
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/offerrall/pytypehintweb
-Project-URL: Repository, https://github.com/offerrall/pytypehintweb
-Project-URL: Issues, https://github.com/offerrall/pytypehintweb/issues
-Keywords: forms,type-hints,dataclasses,schema,web,html
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: JavaScript
-Classifier: Topic :: Software Development :: User Interfaces
-Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
-Classifier: Typing :: Typed
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pytypehint==1.0.0
-Provides-Extra: demo
-Requires-Dist: fastapi; extra == "demo"
-Requires-Dist: uvicorn; extra == "demo"
-Requires-Dist: python-multipart; extra == "demo"
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: mypy; extra == "test"
-Dynamic: license-file
-
-# pytypehintweb 1.2.0
-
-[![PyPI version](https://img.shields.io/pypi/v/pytypehintweb.svg)](https://pypi.org/project/pytypehintweb/)
-[![Python](https://img.shields.io/pypi/pyversions/pytypehintweb.svg)](https://pypi.org/project/pytypehintweb/)
-[![License](https://img.shields.io/pypi/l/pytypehintweb.svg)](LICENSE)
-
-Python schemas in. Portable form plans and browser widgets out.
-
-`pytypehintweb` is a framework-free browser form layer for
-[`pytypehint`](https://github.com/offerrall/pytypehint). It converts compiled
-Python type schemas into self-contained, JSON-serializable form plans and
-renders them with plain JavaScript widgets. The browser runtime also consumes
-hand-written plans or plans from another backend, so Python is not required at
-render time. Everything around the form — routing, static-file delivery,
-authentication, submission, function execution — belongs to the host
-application. (For the whole request/response cycle instead of the rendering
-layer, see [FuncToWeb](https://github.com/offerrall/FuncToWeb).)
-
-The public API — `plan_of()`, `decode()`, `WebConfig`, `STATIC` and the plan's
-own `v: 1` contract — is settled, and a breaking change to any of them belongs
-to a major release. Internals carry no such promise: 1.1.0 replaced most of
-`decode()` with a call into the core, and that kind of change is expected.
-
-## Features
-
-- Self-contained, JSON-serializable plans from plain functions, dataclass types
-  or compiled `Signature`/`Struct` schemas — and hand-written plans need no
-  Python.
-- Framework-free browser runtime (plain HTML, CSS and JS modules), with widgets
-  usable directly or from a plan; browser files ship inside the Python package
-  under `pytypehintweb.STATIC`.
-- Optional stylesheet scoped to a `.pth-root` container, with a light/dark theme
-  that follows the system or is forced with `data-pth-theme` — pure CSS, no
-  theme JavaScript and no flash. Its icons are plain `.svg` files served beside
-  it, so no `img-src data:` is needed.
-- `str`, `int`, `float`, `date`, `time`, `bool` and `enum` composing through lists,
-  optional fields, unions and nested dataclasses, with constraints, static choices,
-  integer sliders, and configurable validation messages and labels.
-- `file` fields (single, optional or `list[File]`, and inside dataclasses) that
-  mint an upload reference the host redeems through its own channel, and that
-  accept an existing reference as a plan default or through `setValue()`.
-- Centralized plan normalization and validation before any widget is built, and
-  `plain` / `inline` / `wrapped` union transport.
-- Plan text is always rendered as text, never parsed as markup.
-
-## Installation
-
-```bash
-pip install pytypehintweb            # library
-pip install "pytypehintweb[demo]"    # + the local demo (pytypehintweb-demo)
-```
-
-```bash
-# Demo with all widgets, served by a local HTTP server on port 8000:
-pytypehintweb-demo
-```
-
-There is no npm package: the browser modules live under `pytypehintweb.STATIC`
-and can be served by any static-file mount.
-
-## Quick start
-
-```python
-from typing import Annotated
-
-from pytypehint import Label, Min
-from pytypehintweb import plan_of
-
-
-def create_user(
-    username: Annotated[str, Min(3), Label("Username")],
-    age: Annotated[int, Min(0), Label("Age")],
-) -> None:
-    pass
-
-
-plan = plan_of(create_user)
-```
-
-`plan_of()` returns ordinary Python dictionaries and lists — a single, fully
-expanded, self-contained document where every non-conditional property is present
-with an explicit value (`default` appears exactly when `hasDefault` is true),
-carrying a top-level `"v": 1`:
-
-```json
-{
-  "v": 1,
-  "kind": "form",
-  "name": "create_user",
-  "description": null,
-  "fields": [
-    {
-      "name": "username",
-      "label": "Username",
-      "description": null,
-      "optional": false,
-      "enabled": true,
-      "hasDefault": false,
-      "node": {
-        "kind": "str",
-        "options": {
-          "minLength": 3,
-          "maxLength": null,
-          "pattern": null,
-          "patternMessage": "Invalid format",
-          "minMessage": "Must contain at least {value} characters",
-          "maxMessage": "Must contain at most {value} characters",
-          "placeholder": null,
-          "password": false,
-          "rows": null,
-          "choices": null
-        }
-      }
-    },
-    {
-      "name": "age",
-      "label": "Age",
-      "description": null,
-      "optional": false,
-      "enabled": true,
-      "hasDefault": false,
-      "node": {
-        "kind": "int",
-        "options": {
-          "min": 0,
-          "max": null,
-          "multipleOf": null,
-          "step": null,
-          "slider": false,
-          "showValue": false,
-          "placeholder": null,
-          "choices": null,
-          "safeMessage": "Must be a safe integer",
-          "invalidMessage": "Enter a valid integer",
-          "minMessage": "Must be at least {value}",
-          "maxMessage": "Must be at most {value}",
-          "multipleOfMessage": "Must be a multiple of {value}",
-          "increaseLabel": "Increase",
-          "decreaseLabel": "Decrease"
-        }
-      }
-    }
-  ]
-}
-```
-
-Transporting that document to the browser and compiling it with `compileForm()`
-is walked through end to end in [Getting started](docs/getting-started.md).
-
-## Documentation
-
-- [Getting started](docs/getting-started.md) — the end-to-end tutorial.
-- [Plan contract](docs/plan.md) — the plan format, every property and invariant.
-- [Python API](docs/python.md) — `plan_of()`, `WebConfig`, annotation mappings.
-- [JavaScript API](docs/javascript.md) — `compileForm()`, widgets, reading,
-  accessibility, styling and themes.
-- [Architecture](docs/architecture.md) — layers and which layer owns each rule.
-- [Testing](docs/testing.md) — how to run the suites and what they guarantee.
-- [Current limitations](docs/limitations.md).