func-to-web 2.7.2__tar.gz → 2.7.4__tar.gz

func_to_web-2.7.4/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: func-to-web
+Version: 2.7.4
+Summary: Expose typed Python functions as web interfaces.
+Author: Beltrán Offerrall
+License: MIT License
+        
+        Copyright (c) 2025 Beltrán Offerrall
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/offerrall/FuncToWeb
+Project-URL: Documentation, https://offerrall.github.io/func-to-web/
+Project-URL: Repository, https://github.com/offerrall/FuncToWeb
+Keywords: web,forms,type-hints,ui
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytypehintweb==1.2.0
+Requires-Dist: starlette==0.49.3
+Requires-Dist: uvicorn==0.38.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: httpx; extra == "test"
+Requires-Dist: build; extra == "test"
+Requires-Dist: twine; extra == "test"
+Requires-Dist: fastapi==0.121.1; extra == "test"
+Provides-Extra: test-outputs
+Requires-Dist: pandas; extra == "test-outputs"
+Requires-Dist: polars; extra == "test-outputs"
+Requires-Dist: numpy; extra == "test-outputs"
+Requires-Dist: pillow; extra == "test-outputs"
+Requires-Dist: matplotlib; extra == "test-outputs"
+Provides-Extra: test-browser
+Requires-Dist: playwright; extra == "test-browser"
+Dynamic: license-file
+
+# FuncToWeb
+
+**Turn typed Python functions into web interfaces.**
+
+Write a normal Python function with type hints. FuncToWeb turns it into a
+ready-to-use web form, validates its input and runs it over HTTP. No models, no
+duplicated schemas, no hand-written forms.
+
+The same function is also an HTTP endpoint, a contract published at `/doc` for
+people and agents, an application you mount inside FastAPI, and a page your own
+frontend opens in a modal.
+
+```python
+from func_to_web import run
+
+def divide(a: float, b: float) -> float:
+    return a / b  # Any exception becomes a clean error in the page and the API
+
+run(divide)  # http://127.0.0.1:8000
+```
+
+The full documentation is at https://offerrall.github.io/func-to-web/.
+
+## Documentation
+
+- [Overview](docs/overview.md): the same function as a form, an API, a contract and a modal; how it works, what it offers and how it compares.
+- [Getting started](docs/getting-started.md): write your first function and run it.
+- [Examples](docs/examples.md): the runnable examples and mini-apps, how to run them, and what each folder teaches.
+- [`run()`](docs/run.md): the standalone application and the space index.
+- [`app_of()`](docs/router.md): mounting the application in an existing FastAPI host application.
+- [Types and validation](docs/types.md): constraints, dataclasses, lists, unions, optionals and defaults.
+- [Prefill and hidden parameters](docs/prefill.md): open a form with initial values, from Python or from the URL.
+- [Files](docs/files.md): uploads, reusable file references, and which layer applies each limit.
+- [`WebFunction` and `WebFunctions`](docs/web-function.md): the name, description and slug of a function; prepared spaces.
+- [Execution over HTTP](docs/http.md): `/invoke`, the request body, the envelope and the status codes.
+- [Streaming](docs/streaming.md): `/invoke-stream`, SSE events and `print()` capture.
+- [Outputs](docs/outputs.md): text, images, tables and downloads with `Download`.
+- [`OpenForm`](docs/open-form.md): open another function's form with the return value as prefill.
+- [`/doc`](docs/api-docs.md): the published contract that a client or an agent consumes.
+- [`sdk.js`](docs/sdk.md): the helpers that call a space from your own frontend, and how to embed a function's page in another site.
+- [Static assets](docs/static-assets.md): `/static`, the icons, the theme and how they are cached.
+- [Security](docs/security.md): what FuncToWeb covers and what belongs to the host application.
+- [Architecture](docs/architecture.md): the layers and what each one solves.
+- [Limitations](docs/limitations.md): the known limits, in a single list.
+
+### Maintaining
+
+- [The space index](docs/design/run.md): why the page `run()` adds at `/` navigates with `location.replace()` and carries no form logic of its own.
+- [The application](docs/design/router.md): why both storage TTLs default to one hour, and why the theme is resolved in pure CSS.
+- [Prefill: from the query parameter to the plan](docs/design/prefill.md): what happens between the `prefill` query parameter and the HTML that is served.
+- [Files: the upload endpoint, the reference and custody](docs/design/files.md): why `/upload` does not apply `FileHint.max_size`, why a second upload of the same reference is a `409`, and where custody of a promoted file ends up.
+- [`WebFunction` metadata](docs/design/web-function.md): why the description is passed through `cleandoc()`, and why only the first letter of a displayed name is uppercased.
+- [Streaming and print capture](docs/design/streaming.md): how `print()` capture works, why it is experimental, and why the transport polls.
+- [Outputs](docs/design/outputs.md): why table rows are read with `itertuples()`, why a matplotlib figure is closed, and why a union cannot mix a download with an ordinary branch.
+- [The iframe channel: three decisions](docs/design/sdk.md): why the modal does not close itself by default, why `error` is not about validation, and why the payload of `result` is the envelope of `/invoke` again.
+- [Frontend: assets, icons and color](docs/design/frontend.md): why the content type is decided rather than guessed, why every icon is a file, and why the page adds almost no color of its own.
+- [Architecture: what counts as public contract](docs/design/architecture.md): why the line between the public API and the merely visible internals falls where it does.
+- [What changed underneath, from 1.6 to 2.0](docs/design/history-1.6-to-2.0.md): why 2.0 breaks what it breaks: the two layers underneath were rewritten, and what that widened, lost and left as a limit.

func_to_web-2.7.4/README.md

@@ -0,0 +1,58 @@
+# FuncToWeb
+
+**Turn typed Python functions into web interfaces.**
+
+Write a normal Python function with type hints. FuncToWeb turns it into a
+ready-to-use web form, validates its input and runs it over HTTP. No models, no
+duplicated schemas, no hand-written forms.
+
+The same function is also an HTTP endpoint, a contract published at `/doc` for
+people and agents, an application you mount inside FastAPI, and a page your own
+frontend opens in a modal.
+
+```python
+from func_to_web import run
+
+def divide(a: float, b: float) -> float:
+    return a / b  # Any exception becomes a clean error in the page and the API
+
+run(divide)  # http://127.0.0.1:8000
+```
+
+The full documentation is at https://offerrall.github.io/func-to-web/.
+
+## Documentation
+
+- [Overview](docs/overview.md): the same function as a form, an API, a contract and a modal; how it works, what it offers and how it compares.
+- [Getting started](docs/getting-started.md): write your first function and run it.
+- [Examples](docs/examples.md): the runnable examples and mini-apps, how to run them, and what each folder teaches.
+- [`run()`](docs/run.md): the standalone application and the space index.
+- [`app_of()`](docs/router.md): mounting the application in an existing FastAPI host application.
+- [Types and validation](docs/types.md): constraints, dataclasses, lists, unions, optionals and defaults.
+- [Prefill and hidden parameters](docs/prefill.md): open a form with initial values, from Python or from the URL.
+- [Files](docs/files.md): uploads, reusable file references, and which layer applies each limit.
+- [`WebFunction` and `WebFunctions`](docs/web-function.md): the name, description and slug of a function; prepared spaces.
+- [Execution over HTTP](docs/http.md): `/invoke`, the request body, the envelope and the status codes.
+- [Streaming](docs/streaming.md): `/invoke-stream`, SSE events and `print()` capture.
+- [Outputs](docs/outputs.md): text, images, tables and downloads with `Download`.
+- [`OpenForm`](docs/open-form.md): open another function's form with the return value as prefill.
+- [`/doc`](docs/api-docs.md): the published contract that a client or an agent consumes.
+- [`sdk.js`](docs/sdk.md): the helpers that call a space from your own frontend, and how to embed a function's page in another site.
+- [Static assets](docs/static-assets.md): `/static`, the icons, the theme and how they are cached.
+- [Security](docs/security.md): what FuncToWeb covers and what belongs to the host application.
+- [Architecture](docs/architecture.md): the layers and what each one solves.
+- [Limitations](docs/limitations.md): the known limits, in a single list.
+
+### Maintaining
+
+- [The space index](docs/design/run.md): why the page `run()` adds at `/` navigates with `location.replace()` and carries no form logic of its own.
+- [The application](docs/design/router.md): why both storage TTLs default to one hour, and why the theme is resolved in pure CSS.
+- [Prefill: from the query parameter to the plan](docs/design/prefill.md): what happens between the `prefill` query parameter and the HTML that is served.
+- [Files: the upload endpoint, the reference and custody](docs/design/files.md): why `/upload` does not apply `FileHint.max_size`, why a second upload of the same reference is a `409`, and where custody of a promoted file ends up.
+- [`WebFunction` metadata](docs/design/web-function.md): why the description is passed through `cleandoc()`, and why only the first letter of a displayed name is uppercased.
+- [Streaming and print capture](docs/design/streaming.md): how `print()` capture works, why it is experimental, and why the transport polls.
+- [Outputs](docs/design/outputs.md): why table rows are read with `itertuples()`, why a matplotlib figure is closed, and why a union cannot mix a download with an ordinary branch.
+- [The iframe channel: three decisions](docs/design/sdk.md): why the modal does not close itself by default, why `error` is not about validation, and why the payload of `result` is the envelope of `/invoke` again.
+- [Frontend: assets, icons and color](docs/design/frontend.md): why the content type is decided rather than guessed, why every icon is a file, and why the page adds almost no color of its own.
+- [Architecture: what counts as public contract](docs/design/architecture.md): why the line between the public API and the merely visible internals falls where it does.
+- [What changed underneath, from 1.6 to 2.0](docs/design/history-1.6-to-2.0.md): why 2.0 breaks what it breaks: the two layers underneath were rewritten, and what that widened, lost and left as a limit.

{func_to_web-2.7.2 → func_to_web-2.7.4}/pyproject.toml

@@ -57,7 +57,8 @@ test-browser = [
 
 [project.urls]
 Homepage = "https://github.com/offerrall/FuncToWeb"
-Source = "https://github.com/offerrall/FuncToWeb"
+Documentation = "https://offerrall.github.io/func-to-web/"
+Repository = "https://github.com/offerrall/FuncToWeb"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]

{func_to_web-2.7.2 → func_to_web-2.7.4}/src/func_to_web/config.py

@@ -3,7 +3,7 @@ from pathlib import Path
 from sys import platform
 from tempfile import gettempdir
 
-__version__ = "2.7.2"
+__version__ = "2.7.4"
 
 NAME: str = "".join(part.title() for part in __name__.split(".")[0].split("_"))
 

func_to_web-2.7.4/src/func_to_web.egg-info/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: func-to-web
+Version: 2.7.4
+Summary: Expose typed Python functions as web interfaces.
+Author: Beltrán Offerrall
+License: MIT License
+        
+        Copyright (c) 2025 Beltrán Offerrall
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/offerrall/FuncToWeb
+Project-URL: Documentation, https://offerrall.github.io/func-to-web/
+Project-URL: Repository, https://github.com/offerrall/FuncToWeb
+Keywords: web,forms,type-hints,ui
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytypehintweb==1.2.0
+Requires-Dist: starlette==0.49.3
+Requires-Dist: uvicorn==0.38.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: httpx; extra == "test"
+Requires-Dist: build; extra == "test"
+Requires-Dist: twine; extra == "test"
+Requires-Dist: fastapi==0.121.1; extra == "test"
+Provides-Extra: test-outputs
+Requires-Dist: pandas; extra == "test-outputs"
+Requires-Dist: polars; extra == "test-outputs"
+Requires-Dist: numpy; extra == "test-outputs"
+Requires-Dist: pillow; extra == "test-outputs"
+Requires-Dist: matplotlib; extra == "test-outputs"
+Provides-Extra: test-browser
+Requires-Dist: playwright; extra == "test-browser"
+Dynamic: license-file
+
+# FuncToWeb
+
+**Turn typed Python functions into web interfaces.**
+
+Write a normal Python function with type hints. FuncToWeb turns it into a
+ready-to-use web form, validates its input and runs it over HTTP. No models, no
+duplicated schemas, no hand-written forms.
+
+The same function is also an HTTP endpoint, a contract published at `/doc` for
+people and agents, an application you mount inside FastAPI, and a page your own
+frontend opens in a modal.
+
+```python
+from func_to_web import run
+
+def divide(a: float, b: float) -> float:
+    return a / b  # Any exception becomes a clean error in the page and the API
+
+run(divide)  # http://127.0.0.1:8000
+```
+
+The full documentation is at https://offerrall.github.io/func-to-web/.
+
+## Documentation
+
+- [Overview](docs/overview.md): the same function as a form, an API, a contract and a modal; how it works, what it offers and how it compares.
+- [Getting started](docs/getting-started.md): write your first function and run it.
+- [Examples](docs/examples.md): the runnable examples and mini-apps, how to run them, and what each folder teaches.
+- [`run()`](docs/run.md): the standalone application and the space index.
+- [`app_of()`](docs/router.md): mounting the application in an existing FastAPI host application.
+- [Types and validation](docs/types.md): constraints, dataclasses, lists, unions, optionals and defaults.
+- [Prefill and hidden parameters](docs/prefill.md): open a form with initial values, from Python or from the URL.
+- [Files](docs/files.md): uploads, reusable file references, and which layer applies each limit.
+- [`WebFunction` and `WebFunctions`](docs/web-function.md): the name, description and slug of a function; prepared spaces.
+- [Execution over HTTP](docs/http.md): `/invoke`, the request body, the envelope and the status codes.
+- [Streaming](docs/streaming.md): `/invoke-stream`, SSE events and `print()` capture.
+- [Outputs](docs/outputs.md): text, images, tables and downloads with `Download`.
+- [`OpenForm`](docs/open-form.md): open another function's form with the return value as prefill.
+- [`/doc`](docs/api-docs.md): the published contract that a client or an agent consumes.
+- [`sdk.js`](docs/sdk.md): the helpers that call a space from your own frontend, and how to embed a function's page in another site.
+- [Static assets](docs/static-assets.md): `/static`, the icons, the theme and how they are cached.
+- [Security](docs/security.md): what FuncToWeb covers and what belongs to the host application.
+- [Architecture](docs/architecture.md): the layers and what each one solves.
+- [Limitations](docs/limitations.md): the known limits, in a single list.
+
+### Maintaining
+
+- [The space index](docs/design/run.md): why the page `run()` adds at `/` navigates with `location.replace()` and carries no form logic of its own.
+- [The application](docs/design/router.md): why both storage TTLs default to one hour, and why the theme is resolved in pure CSS.
+- [Prefill: from the query parameter to the plan](docs/design/prefill.md): what happens between the `prefill` query parameter and the HTML that is served.
+- [Files: the upload endpoint, the reference and custody](docs/design/files.md): why `/upload` does not apply `FileHint.max_size`, why a second upload of the same reference is a `409`, and where custody of a promoted file ends up.
+- [`WebFunction` metadata](docs/design/web-function.md): why the description is passed through `cleandoc()`, and why only the first letter of a displayed name is uppercased.
+- [Streaming and print capture](docs/design/streaming.md): how `print()` capture works, why it is experimental, and why the transport polls.
+- [Outputs](docs/design/outputs.md): why table rows are read with `itertuples()`, why a matplotlib figure is closed, and why a union cannot mix a download with an ordinary branch.
+- [The iframe channel: three decisions](docs/design/sdk.md): why the modal does not close itself by default, why `error` is not about validation, and why the payload of `result` is the envelope of `/invoke` again.
+- [Frontend: assets, icons and color](docs/design/frontend.md): why the content type is decided rather than guessed, why every icon is a file, and why the page adds almost no color of its own.
+- [Architecture: what counts as public contract](docs/design/architecture.md): why the line between the public API and the merely visible internals falls where it does.
+- [What changed underneath, from 1.6 to 2.0](docs/design/history-1.6-to-2.0.md): why 2.0 breaks what it breaks: the two layers underneath were rewritten, and what that widened, lost and left as a limit.