sshscript 4.0.1__tar.gz → 4.0.2__tar.gz

{sshscript-4.0.1 → sshscript-4.0.2}/API_GUIDE.md

@@ -1,8 +1,8 @@
 # Recommended SSHScript API
 
 This is the canonical entry point for new code and AI-generated examples.
-**Current contract: 4.0.1**, Python 3.11+. Sections marked **4.0** require
-SSHScript 4.0.1; installing `sshscript==3.1.5` does not provide them.
+**Current contract: 4.0.2**, Python 3.11+. Sections marked **4.0** require
+SSHScript 4.0.2; installing `sshscript==3.1.5` does not provide them.
 Examples labelled 3.1.5 remain verified compatibility examples for that baseline.
 Pin the exact artifact version and record it with execution diagnostics when
 handing off automation. See [version policy and migration](VERSIONING.md).
@@ -29,9 +29,11 @@ identifiers and handoff reports are future work, not a current API guarantee.
 | Long-running program | **4.0:** `start(timeout=None)`, `stop()`, `wait()` |
 | Session-wide failure/output policy | **4.0:** `set(...)`, `get(...)`, or matching properties |
 
-## 3.1.5: one command, one retained result
+## One command, one retained result (4.0; compatible with 3.1.5)
 
-Install the baseline with `python -m pip install "sshscript==3.1.5"`.
+Install the current release with `python -m pip install "sshscript==4.0.2"`.
+For reproducing only the historical compatibility baseline, explicitly install
+`sshscript==3.1.5`; the 4.0 sections require the current release.
 An argv list is one command, not a batch. Shell-looking argument text stays data.
 
 <!-- example: {"id":"argv", "profile":"3.1.5", "stdout":"a; b\n"} -->
@@ -67,7 +69,7 @@ with closing(Session()) as local:
         print(f"failed: {error.returncode}")
 ```
 
-## 3.1.5: SSH and optional dollar syntax
+## SSH and optional dollar syntax (4.0; compatible with 3.1.5)
 
 Replace the example host with your configured host and verified known-host key.
 CI executes this block with a local SSH protocol fixture in place of the login;
@@ -99,7 +101,7 @@ print(result.stdout)
 
 ## 4.0: settings and managed jobs
 
-Use SSHScript 4.0.1 for the following examples. CLI `-v`, `--stderr`, and
+Use SSHScript 4.0.2 for the following examples. CLI `-v`, `--stderr`, and
 `--debug` override root defaults only for that execution. Child Sessions copy
 their parent's settings. `set()` validates before changing anything; `get()`
 returns a copy. Explicit command options override Session policy.
@@ -118,7 +120,7 @@ the settings dictionary at creation; the policy object itself is shared, so
 custom policies with mutable state must account for reuse. Changing the setting
 does not reconfigure existing connections.
 
-<!-- example: {"id":"settings", "profile":"4.0.1", "stdout":"True\n1\n"} -->
+<!-- example: {"id":"settings", "profile":"4.0.2", "stdout":"True\n1\n"} -->
 ```python
 from contextlib import closing
 import paramiko
@@ -140,7 +142,7 @@ semantics; do not combine it with `command_timeout`.
 For an indefinite command such as tcpdump, use `start(timeout=None)`. This safe
 local example uses a small Python process instead of capturing network traffic:
 
-<!-- example: {"id":"stop", "profile":"4.0.1", "stdout":"cancelled confirmed\n"} -->
+<!-- example: {"id":"stop", "profile":"4.0.2", "stdout":"cancelled confirmed\n"} -->
 ```python
 from contextlib import closing
 import sys
@@ -179,7 +181,7 @@ legacy SSH behavior which appended a newline to strings: if a consumer
 needs a line, migrate `input=password` to `input=password + "\n"` explicitly.
 Published 3.1.5 still has the legacy SSH behavior.
 
-<!-- example: {"id":"exact-stdin", "profile":"4.0.1", "stdout":"'abc'\n'abc\\n'\n"} -->
+<!-- example: {"id":"exact-stdin", "profile":"4.0.2", "stdout":"'abc'\n'abc\\n'\n"} -->
 ```python
 from contextlib import closing
 import sys
@@ -248,7 +250,7 @@ or unpack exactly `stdout, stderr, exitcode`. This changes the released 3.1.5
 console contract: old `stdout, stderr = shell(command)` must be migrated.
 Shell calls accept command strings; argv execution belongs to Session.
 
-<!-- example: {"id":"shell-result", "profile":"4.0.1", "stdout":"first 0\n"} -->
+<!-- example: {"id":"shell-result", "profile":"4.0.2", "stdout":"first 0\n"} -->
 ```python
 from contextlib import closing
 from sshscript import Session
@@ -304,7 +306,7 @@ matching: `iter_stdout()` yields chunks, not packets or lines. Put `stop()` in
 `finally`, so condition matches, exceptions, and KeyboardInterrupt all trigger
 cleanup. This credential-free example uses a continuous Python process:
 
-<!-- example: {"id":"stream-condition", "profile":"4.0.1", "stdout":"cancelled confirmed\n"} -->
+<!-- example: {"id":"stream-condition", "profile":"4.0.2", "stdout":"cancelled confirmed\n"} -->
 ```python
 from contextlib import closing
 import sys
@@ -369,7 +371,7 @@ the current Bash console's channel, cwd, environment and identity. It does not
 launch through the underlying Session. Ordinary `console(command)` / `$command`
 still waits and returns `CommandResult`; no migration is needed for finite commands.
 
-<!-- example: {"id":"console-stream", "profile":"4.0.1", "stdout":"cancelled confirmed\nconsole-alive\n"} -->
+<!-- example: {"id":"console-stream", "profile":"4.0.2", "stdout":"cancelled confirmed\nconsole-alive\n"} -->
 ```python
 from contextlib import closing
 import shlex
@@ -509,7 +511,7 @@ remains available for other authentication prompt formats.
 These transcripts require a real local account and its authentication policy;
 they are manual examples, separate from the credential-free CI examples above.
 Read passwords with `getpass` rather than storing them in the script. The new
-behavior requires 4.0.1 and does not apply to the installed 3.1.5 release.
+behavior requires 4.0.2 and does not apply to the installed 3.1.5 release.
 
 Open a root console through sudo and allow up to 15 seconds for entry:
 

{sshscript-4.0.1 → sshscript-4.0.2}/CHANGELOG.md

@@ -3,6 +3,16 @@
 This project records user-visible changes here. Release artifacts and their
 provenance are available from the linked GitHub Release and PyPI pages.
 
+## 4.0.2 — 2026-10-09
+
+- Align the README, current installation commands, website title, navigation,
+  footer, and version metadata with the current 4.0 release.
+- Point general PyPI and GitHub Release links to current entry points; retain
+  explicitly labelled historical releases and existing documentation URLs.
+- Check current website version labels and release links during documentation
+  validation, including rendered header/footer links and anchors.
+- Preserve the 4.0.1 public execution contract; no runtime behavior changes.
+
 ## 4.0.1 — 2026-10-08
 
 - Settle the legacy command worker before propagating timeout/transport errors;

{sshscript-4.0.1/src/sshscript.egg-info → sshscript-4.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sshscript
-Version: 4.0.1
+Version: 4.0.2
 Summary: Python automation for local processes, SSH, and SSHScript .spy files
 Author-email: "Yeh, Hsin-Yuan" <iapyeh@gmail.com>
 License-Expression: MIT
@@ -47,7 +47,7 @@ output and status, distinguish failure from timeout, and make cleanup and
 unknown termination explicit. A successful command exit is evidence about
 that command; verify the deployment or other application outcome separately.
 
-**Current release:** [4.0.1](https://github.com/iapyeh/sshscript/releases/tag/v4.0.1)
+**Current release:** [4.0.2](https://github.com/iapyeh/sshscript/releases/tag/v4.0.2)
 (Production/Stable) · **Python:** 3.11 or newer · **Tested:** Python
 3.11–3.14 on Linux and macOS
 
@@ -57,7 +57,8 @@ that command; verify the deployment or other application outcome separately.
 [Security](https://github.com/iapyeh/sshscript/security/policy) ·
 [Support](https://github.com/iapyeh/sshscript/blob/release/SUPPORT.md)
 
-**Version 4.0.1** introduces the incompatible 4.0 execution contract.
+**Version 4.0.2** maintains the 4.0 execution contract introduced in 4.0.1.
+This patch aligns the published documentation and installation links.
 Upgrade 3.1.5 automation using the migration guide and application regressions.
 See [version policy and migration](VERSIONING.md) before upgrading automation.
 
@@ -114,7 +115,7 @@ pin SSHScript and all transitive dependencies in your application's lock file.
 To install this release explicitly:
 
 ```sh
-python3 -m pip install "sshscript==3.1.5"
+python3 -m pip install "sshscript==4.0.2"
 ```
 
 Use `python3 -m pip install --upgrade sshscript` to upgrade. The optional
@@ -123,7 +124,8 @@ it never installs an update by itself.
 
 ## 60-second local quickstart
 
-This example uses the published 3.1.5 command API.
+This example runs on 4.0.2 and retains compatibility with the 3.1.5 command API.
+The metadata below records that older compatibility baseline.
 
 <!-- example: {"id":"readme-quickstart", "profile":"3.1.5", "stdout":"sshscript is ready\nexit code: 0\n"} -->
 ```python
@@ -374,7 +376,7 @@ Unknown and changed host keys are rejected unless the caller explicitly
 supplies a different Paramiko policy. Do not use automatic key acceptance in a
 production workflow unless a separate trusted bootstrap process has already
 verified the key. See the
-[SSHScript v3 documentation](https://iapyeh.github.io/sshscript/v3a/) for
+[SSHScript documentation](https://iapyeh.github.io/sshscript/v3a/) for
 nested connections, timeouts, file transfer, `sudo`, `su`, and interactive
 programs.
 

{sshscript-4.0.1 → sshscript-4.0.2}/README.md

@@ -16,7 +16,7 @@ output and status, distinguish failure from timeout, and make cleanup and
 unknown termination explicit. A successful command exit is evidence about
 that command; verify the deployment or other application outcome separately.
 
-**Current release:** [4.0.1](https://github.com/iapyeh/sshscript/releases/tag/v4.0.1)
+**Current release:** [4.0.2](https://github.com/iapyeh/sshscript/releases/tag/v4.0.2)
 (Production/Stable) · **Python:** 3.11 or newer · **Tested:** Python
 3.11–3.14 on Linux and macOS
 
@@ -26,7 +26,8 @@ that command; verify the deployment or other application outcome separately.
 [Security](https://github.com/iapyeh/sshscript/security/policy) ·
 [Support](https://github.com/iapyeh/sshscript/blob/release/SUPPORT.md)
 
-**Version 4.0.1** introduces the incompatible 4.0 execution contract.
+**Version 4.0.2** maintains the 4.0 execution contract introduced in 4.0.1.
+This patch aligns the published documentation and installation links.
 Upgrade 3.1.5 automation using the migration guide and application regressions.
 See [version policy and migration](VERSIONING.md) before upgrading automation.
 
@@ -83,7 +84,7 @@ pin SSHScript and all transitive dependencies in your application's lock file.
 To install this release explicitly:
 
 ```sh
-python3 -m pip install "sshscript==3.1.5"
+python3 -m pip install "sshscript==4.0.2"
 ```
 
 Use `python3 -m pip install --upgrade sshscript` to upgrade. The optional
@@ -92,7 +93,8 @@ it never installs an update by itself.
 
 ## 60-second local quickstart
 
-This example uses the published 3.1.5 command API.
+This example runs on 4.0.2 and retains compatibility with the 3.1.5 command API.
+The metadata below records that older compatibility baseline.
 
 <!-- example: {"id":"readme-quickstart", "profile":"3.1.5", "stdout":"sshscript is ready\nexit code: 0\n"} -->
 ```python
@@ -343,7 +345,7 @@ Unknown and changed host keys are rejected unless the caller explicitly
 supplies a different Paramiko policy. Do not use automatic key acceptance in a
 production workflow unless a separate trusted bootstrap process has already
 verified the key. See the
-[SSHScript v3 documentation](https://iapyeh.github.io/sshscript/v3a/) for
+[SSHScript documentation](https://iapyeh.github.io/sshscript/v3a/) for
 nested connections, timeouts, file transfer, `sudo`, `su`, and interactive
 programs.
 

{sshscript-4.0.1 → sshscript-4.0.2}/VERSIONING.md

@@ -9,11 +9,11 @@ claim that a command or deployment is safe or successful.
 | Version | Contract and status |
 | --- | --- |
 | 3.1.5 | Published baseline described in API_GUIDE.md; one-shot Session commands return CommandResult, but persistent console calls return two live buffers. |
-| 4.0.1 | Production contract: completed console results, settings, managed jobs and authenticated-console handshakes; incompatible with parts of 3.1.5. |
+| 4.0.2 | Production contract: completed console results, settings, managed jobs and authenticated-console handshakes; incompatible with parts of 3.1.5. |
 
-Version 4.0.1 is the first published 4.0 contract, promoted from the development
-line after release validation. The patch component was incremented once for
-this publication. Native-system validation limits remain documented.
+Version 4.0.1 introduced the published 4.0 contract after release validation.
+Version 4.0.2 is a documentation and link maintenance patch with the same public
+execution contract. Native-system validation limits remain documented.
 Use the normal Python Session API as the canonical entry point; optional .spy
 syntax follows the same versioned execution contract.
 

{sshscript-4.0.1 → sshscript-4.0.2}/src/sshscript/_version.py

@@ -1,3 +1,3 @@
 """Single source of the SSHScript package version."""
 
-__version__ = "4.0.1"
+__version__ = "4.0.2"

{sshscript-4.0.1 → sshscript-4.0.2/src/sshscript.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sshscript
-Version: 4.0.1
+Version: 4.0.2
 Summary: Python automation for local processes, SSH, and SSHScript .spy files
 Author-email: "Yeh, Hsin-Yuan" <iapyeh@gmail.com>
 License-Expression: MIT
@@ -47,7 +47,7 @@ output and status, distinguish failure from timeout, and make cleanup and
 unknown termination explicit. A successful command exit is evidence about
 that command; verify the deployment or other application outcome separately.
 
-**Current release:** [4.0.1](https://github.com/iapyeh/sshscript/releases/tag/v4.0.1)
+**Current release:** [4.0.2](https://github.com/iapyeh/sshscript/releases/tag/v4.0.2)
 (Production/Stable) · **Python:** 3.11 or newer · **Tested:** Python
 3.11–3.14 on Linux and macOS
 
@@ -57,7 +57,8 @@ that command; verify the deployment or other application outcome separately.
 [Security](https://github.com/iapyeh/sshscript/security/policy) ·
 [Support](https://github.com/iapyeh/sshscript/blob/release/SUPPORT.md)
 
-**Version 4.0.1** introduces the incompatible 4.0 execution contract.
+**Version 4.0.2** maintains the 4.0 execution contract introduced in 4.0.1.
+This patch aligns the published documentation and installation links.
 Upgrade 3.1.5 automation using the migration guide and application regressions.
 See [version policy and migration](VERSIONING.md) before upgrading automation.
 
@@ -114,7 +115,7 @@ pin SSHScript and all transitive dependencies in your application's lock file.
 To install this release explicitly:
 
 ```sh
-python3 -m pip install "sshscript==3.1.5"
+python3 -m pip install "sshscript==4.0.2"
 ```
 
 Use `python3 -m pip install --upgrade sshscript` to upgrade. The optional
@@ -123,7 +124,8 @@ it never installs an update by itself.
 
 ## 60-second local quickstart
 
-This example uses the published 3.1.5 command API.
+This example runs on 4.0.2 and retains compatibility with the 3.1.5 command API.
+The metadata below records that older compatibility baseline.
 
 <!-- example: {"id":"readme-quickstart", "profile":"3.1.5", "stdout":"sshscript is ready\nexit code: 0\n"} -->
 ```python
@@ -374,7 +376,7 @@ Unknown and changed host keys are rejected unless the caller explicitly
 supplies a different Paramiko policy. Do not use automatic key acceptance in a
 production workflow unless a separate trusted bootstrap process has already
 verified the key. See the
-[SSHScript v3 documentation](https://iapyeh.github.io/sshscript/v3a/) for
+[SSHScript documentation](https://iapyeh.github.io/sshscript/v3a/) for
 nested connections, timeouts, file transfer, `sudo`, `su`, and interactive
 programs.
 

{sshscript-4.0.1 → sshscript-4.0.2}/tools/sync_api_guide.py

@@ -8,7 +8,7 @@ from pathlib import Path
 
 HEADER = '''---
 title: "Recommended SSHScript API"
-parent: "SSHScript v3.1 Documentation"
+parent: "SSHScript Documentation"
 nav_order: 0
 permalink: /v3a/recommended-api/
 ---