webapp-shell 0.1__tar.gz → 0.2__tar.gz

webapp_shell-0.2/CHANGE_LOG.md

@@ -0,0 +1,3 @@
+# 0.2
+
+- **README:** every link in it is now absolute (to the repository on GitHub), so the links work on the PyPI page, where a relative link led to a 404. The backend example is complete, and freezing and the `freeze` extra are mentioned. A test keeps relative links out of the README.

{webapp_shell-0.1 → webapp_shell-0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: webapp-shell
-Version: 0.1
+Version: 0.2
 Summary: A desktop window for a web app made of a Python backend and a compiled frontend.
 Project-URL: Homepage, https://github.com/prmpsmart/webapp_shell
 Project-URL: Documentation, https://prmpsmart.github.io/webapp_shell
@@ -44,7 +44,7 @@ Description-Content-Type: text/markdown
 [![CI](https://github.com/prmpsmart/webapp_shell/actions/workflows/ci.yml/badge.svg)](https://github.com/prmpsmart/webapp_shell/actions/workflows/ci.yml)
 [![PyPI](https://img.shields.io/pypi/v/webapp-shell)](https://pypi.org/project/webapp-shell/)
 [![Python](https://img.shields.io/pypi/pyversions/webapp-shell)](https://pypi.org/project/webapp-shell/)
-[![Licence: MIT](https://img.shields.io/badge/licence-MIT-blue.svg)](LICENSE)
+[![Licence: MIT](https://img.shields.io/badge/licence-MIT-blue.svg)](https://github.com/prmpsmart/webapp_shell/blob/main/LICENSE)
 [![Docs](https://img.shields.io/badge/docs-site-3556d6)](https://prmpsmart.github.io/webapp_shell)
 
 A desktop window for a web app made of a **Python backend** and a **compiled frontend**. Your project describes itself
@@ -82,9 +82,19 @@ if __name__ == "__main__":
 The backend reads the same contract with the library's helpers (Starlette or FastAPI):
 
 ```python
+import argparse
+
+from starlette.applications import Starlette
+from webapp_shell.contract import TokenValidator, add_launch_arguments, read_launch_arguments
+from webapp_shell.contract.guard import TokenGuard
+
+wire = config.backend.wire  # the same names the shell uses
+
 parser = argparse.ArgumentParser()
 add_launch_arguments(parser, config.backend)  # --port, --frontend, --preferences-file, --token
-launch = read_launch_arguments(parser, parser.parse_args(), config.backend.wire)
+launch = read_launch_arguments(parser, parser.parse_args(), wire)
+
+app = Starlette(...)
 app.add_middleware(TokenGuard, validator=TokenValidator(launch.token, wire), wire=wire)
 ```
 
@@ -117,16 +127,20 @@ const path = await bridge.pickFile([{ name: "Excel", extensions: ["xlsx"] }]);
 const hello = await bridge.call("greet", "Ada");
 ```
 
-Install: `pip install webapp-shell` (pywebview is included); `pip install "webapp-shell[qt]"` adds Qt, and
-`pip install "webapp-shell[backend]"` adds Starlette for the token guard.
+Install: `pip install webapp-shell` (pywebview is included); the extras are `qt` (the Qt window), `backend` (Starlette,
+for the token guard) and `freeze` (PyInstaller, for the next step), for example `pip install "webapp-shell[qt,backend]"`.
+
+Freezing: describe the program in a `FreezePlan` and run `python -m webapp_shell freeze plan:PLAN qt webview`. The
+library writes the entry file and the PyInstaller spec, keeps the other window toolkit out of each build and checks the
+finished folder (see [freezing](https://github.com/prmpsmart/webapp_shell/blob/main/docs/FREEZING.md)).
 
 On Windows the pywebview window needs the WebView2 runtime (present on Windows 11); `pythonnet` is installed by pywebview.
 
 A runnable minimal program is in `examples/minimal/`, and `examples/site/` is the documentation website, opened by the
 library's own shell, with a live demonstration of every feature.
 
-Guides (`docs/`): [the contract](docs/CONTRACT.md), [configuration](docs/CONFIGURATION.md),
-[native functions](docs/NATIVE_FUNCTIONS.md), [freezing with PyInstaller](docs/FREEZING.md),
-[translating](docs/TRANSLATING.md), [troubleshooting](docs/TROUBLESHOOTING.md), and the generated
-[API listing](docs/API.md) (the public API: nothing that is not listed there is promised). The same guides are pages of
-the documentation site. To work on the library, read [CONTRIBUTING.md](CONTRIBUTING.md).
+Guides (`docs/`): [the contract](https://github.com/prmpsmart/webapp_shell/blob/main/docs/CONTRACT.md), [configuration](https://github.com/prmpsmart/webapp_shell/blob/main/docs/CONFIGURATION.md),
+[native functions](https://github.com/prmpsmart/webapp_shell/blob/main/docs/NATIVE_FUNCTIONS.md), [freezing with PyInstaller](https://github.com/prmpsmart/webapp_shell/blob/main/docs/FREEZING.md),
+[translating](https://github.com/prmpsmart/webapp_shell/blob/main/docs/TRANSLATING.md), [troubleshooting](https://github.com/prmpsmart/webapp_shell/blob/main/docs/TROUBLESHOOTING.md), and the generated
+[API listing](https://github.com/prmpsmart/webapp_shell/blob/main/docs/API.md) (the public API: nothing that is not listed there is promised). The same guides are pages of
+the documentation site. To work on the library, read [CONTRIBUTING.md](https://github.com/prmpsmart/webapp_shell/blob/main/CONTRIBUTING.md).

{webapp_shell-0.1 → webapp_shell-0.2}/README.md

@@ -3,7 +3,7 @@
 [![CI](https://github.com/prmpsmart/webapp_shell/actions/workflows/ci.yml/badge.svg)](https://github.com/prmpsmart/webapp_shell/actions/workflows/ci.yml)
 [![PyPI](https://img.shields.io/pypi/v/webapp-shell)](https://pypi.org/project/webapp-shell/)
 [![Python](https://img.shields.io/pypi/pyversions/webapp-shell)](https://pypi.org/project/webapp-shell/)
-[![Licence: MIT](https://img.shields.io/badge/licence-MIT-blue.svg)](LICENSE)
+[![Licence: MIT](https://img.shields.io/badge/licence-MIT-blue.svg)](https://github.com/prmpsmart/webapp_shell/blob/main/LICENSE)
 [![Docs](https://img.shields.io/badge/docs-site-3556d6)](https://prmpsmart.github.io/webapp_shell)
 
 A desktop window for a web app made of a **Python backend** and a **compiled frontend**. Your project describes itself
@@ -41,9 +41,19 @@ if __name__ == "__main__":
 The backend reads the same contract with the library's helpers (Starlette or FastAPI):
 
 ```python
+import argparse
+
+from starlette.applications import Starlette
+from webapp_shell.contract import TokenValidator, add_launch_arguments, read_launch_arguments
+from webapp_shell.contract.guard import TokenGuard
+
+wire = config.backend.wire  # the same names the shell uses
+
 parser = argparse.ArgumentParser()
 add_launch_arguments(parser, config.backend)  # --port, --frontend, --preferences-file, --token
-launch = read_launch_arguments(parser, parser.parse_args(), config.backend.wire)
+launch = read_launch_arguments(parser, parser.parse_args(), wire)
+
+app = Starlette(...)
 app.add_middleware(TokenGuard, validator=TokenValidator(launch.token, wire), wire=wire)
 ```
 
@@ -76,16 +86,20 @@ const path = await bridge.pickFile([{ name: "Excel", extensions: ["xlsx"] }]);
 const hello = await bridge.call("greet", "Ada");
 ```
 
-Install: `pip install webapp-shell` (pywebview is included); `pip install "webapp-shell[qt]"` adds Qt, and
-`pip install "webapp-shell[backend]"` adds Starlette for the token guard.
+Install: `pip install webapp-shell` (pywebview is included); the extras are `qt` (the Qt window), `backend` (Starlette,
+for the token guard) and `freeze` (PyInstaller, for the next step), for example `pip install "webapp-shell[qt,backend]"`.
+
+Freezing: describe the program in a `FreezePlan` and run `python -m webapp_shell freeze plan:PLAN qt webview`. The
+library writes the entry file and the PyInstaller spec, keeps the other window toolkit out of each build and checks the
+finished folder (see [freezing](https://github.com/prmpsmart/webapp_shell/blob/main/docs/FREEZING.md)).
 
 On Windows the pywebview window needs the WebView2 runtime (present on Windows 11); `pythonnet` is installed by pywebview.
 
 A runnable minimal program is in `examples/minimal/`, and `examples/site/` is the documentation website, opened by the
 library's own shell, with a live demonstration of every feature.
 
-Guides (`docs/`): [the contract](docs/CONTRACT.md), [configuration](docs/CONFIGURATION.md),
-[native functions](docs/NATIVE_FUNCTIONS.md), [freezing with PyInstaller](docs/FREEZING.md),
-[translating](docs/TRANSLATING.md), [troubleshooting](docs/TROUBLESHOOTING.md), and the generated
-[API listing](docs/API.md) (the public API: nothing that is not listed there is promised). The same guides are pages of
-the documentation site. To work on the library, read [CONTRIBUTING.md](CONTRIBUTING.md).
+Guides (`docs/`): [the contract](https://github.com/prmpsmart/webapp_shell/blob/main/docs/CONTRACT.md), [configuration](https://github.com/prmpsmart/webapp_shell/blob/main/docs/CONFIGURATION.md),
+[native functions](https://github.com/prmpsmart/webapp_shell/blob/main/docs/NATIVE_FUNCTIONS.md), [freezing with PyInstaller](https://github.com/prmpsmart/webapp_shell/blob/main/docs/FREEZING.md),
+[translating](https://github.com/prmpsmart/webapp_shell/blob/main/docs/TRANSLATING.md), [troubleshooting](https://github.com/prmpsmart/webapp_shell/blob/main/docs/TROUBLESHOOTING.md), and the generated
+[API listing](https://github.com/prmpsmart/webapp_shell/blob/main/docs/API.md) (the public API: nothing that is not listed there is promised). The same guides are pages of
+the documentation site. To work on the library, read [CONTRIBUTING.md](https://github.com/prmpsmart/webapp_shell/blob/main/CONTRIBUTING.md).

webapp_shell-0.1/CHANGE_LOG.md → webapp_shell-0.2/change_logs/0.1.md

@@ -1,6 +1,6 @@
 # 0.1
 
-The first version (not yet published). What it holds:
+The first version (published on PyPI on 1 November 2026). What it holds:
 
 - **The shell as a library:** `run(config)` gives a program its command line; the backend is started, watched and restarted by the shell (`BackendProcess`, `BackendWatchdog`), with a splash and a first-run library check.
 - **Config objects:** `AppIdentity`, `BackendSpec`, `WireProtocol`, `CliFlag` and `ShellConfig`; no program's name is built into the library.

{webapp_shell-0.1 → webapp_shell-0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "webapp-shell"
-version = "0.1"
+version = "0.2"
 description = "A desktop window for a web app made of a Python backend and a compiled frontend."
 readme = "README.md"
 requires-python = ">=3.13"

{webapp_shell-0.1 → webapp_shell-0.2}/tests/test_guides.py

@@ -57,3 +57,9 @@ def test_the_examples_use_only_the_public_modules(path):
         return
     for module in library_imports(path.read_text(encoding="utf-8")):
         assert module in PUBLIC, f"{path.name} imports {module}, which is not public"
+
+
+def test_the_readme_has_no_relative_links():
+    """PyPI shows the README away from the repository: a relative link there leads to a 404."""
+    links = re.findall(r"\]\(([^)]+)\)", (ROOT / "README.md").read_text(encoding="utf-8"))
+    assert [link for link in links if not link.startswith(("https://", "http://", "#"))] == []