toolframe-backup 0.1.0__tar.gz

toolframe_backup-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: Validate Python distribution
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  validate:
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 25
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-15]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: '3.14.7'
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          version: '0.12.8'
+          enable-cache: false
+      - name: Test and install wheel and source distribution
+        run: python scripts/validate_release.py --output dist/validated
+      - name: Retain only validated distributions
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: python-dist-${{ matrix.os }}
+          path: dist/validated/*
+          if-no-files-found: error
+          retention-days: 14

toolframe_backup-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,65 @@
+name: Publish Python distribution
+
+on:
+  workflow_dispatch:
+    inputs:
+      index:
+        description: Package index; run against the matching vVERSION tag
+        type: choice
+        options: [testpypi, pypi]
+        default: testpypi
+        required: true
+
+permissions:
+  contents: read
+
+concurrency:
+  group: publish-${{ inputs.index }}
+  cancel-in-progress: false
+
+jobs:
+  release-tag:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: '3.14.7'
+      - name: Require the exact package version tag
+        env:
+          RELEASE_REF: ${{ github.ref }}
+        run: |
+          python - <<'PYCODE'
+          import os, pathlib, tomllib
+          project = tomllib.loads(pathlib.Path('pyproject.toml').read_text())['project']
+          expected = 'refs/tags/v' + project['version']
+          if os.environ['RELEASE_REF'] != expected:
+              raise SystemExit('Publication requires ' + expected)
+          PYCODE
+
+  validate:
+    needs: release-tag
+    uses: ./.github/workflows/ci.yml
+    secrets: inherit
+
+  publish:
+    needs: [release-tag, validate]
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    environment:
+      name: ${{ inputs.index }}
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: python-dist-ubuntu-24.04
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          packages-dir: dist/
+          repository-url: ${{ inputs.index == 'testpypi' && 'https://test.pypi.org/legacy/' || 'https://upload.pypi.org/legacy/' }}

toolframe_backup-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+/.venv/
+/build/
+/dist/
+/.pytest_cache/
+/.ruff_cache/
+/uv.lock
+__pycache__/
+*.py[cod]
+*.egg-info/
+.DS_Store
+
+# Local working documents, issue state, and development worktrees.
+/.local/
+/.issues/
+/.worktrees/

toolframe_backup-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

toolframe_backup-0.1.0/NOTICE

@@ -0,0 +1,4 @@
+Toolframe Backup
+Copyright 2026 Toolframe contributors
+
+Licensed under the Apache License, Version 2.0.

toolframe_backup-0.1.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.5
+Name: toolframe-backup
+Version: 0.1.0
+Summary: Stopped-application recovery archives and a local Backup catalog for Toolframe
+Project-URL: Homepage, https://github.com/toolframe/toolframe-backup
+Project-URL: Repository, https://github.com/toolframe/toolframe-backup
+Project-URL: Documentation, https://github.com/toolframe/toolframe-backup#readme
+Project-URL: Issues, https://github.com/toolframe/toolframe-backup/issues
+Author-email: byfb <62798989+byfb@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.14
+Requires-Dist: packaging>=25
+Requires-Dist: tomlkit<1,>=0.13
+Requires-Dist: toolframe-sdk==0.3.0
+Provides-Extra: operator
+Requires-Dist: toolframe-core<0.7,>=0.6; extra == 'operator'
+Provides-Extra: ui
+Requires-Dist: streamlit==1.61.0; extra == 'ui'
+Description-Content-Type: text/markdown
+
+# Toolframe Backup
+
+Toolframe Backup creates recovery archives of cleanly stopped Toolframe applications
+and provides a Dashboard and read-only MCP catalog for a configured local backup
+directory. Its standalone CLI can verify or restore archives even when the source
+application cannot start. The ordinary plugin never snapshots a running application.
+
+## Quick start
+
+Use Python 3.14 or newer. Archive creation
+requires a Core release providing `toolframe_core.maintenance.stopped_application`.
+Restoring recorded environments also requires its public `application_lock` helper.
+Install the operator extra from PyPI:
+
+```sh
+uv venv --python 3.14
+uv pip install 'toolframe-backup[operator]==0.1.0'
+# Stop the application's host and workers cleanly before creating the archive.
+.venv/bin/toolframe-backup create --home ./app --directory ./backups
+.venv/bin/toolframe-backup list --directory ./backups
+.venv/bin/toolframe-backup verify ./backups/backup-<id>.zip
+.venv/bin/toolframe-backup restore ./backups/backup-<id>.zip --destination ./recovered-app
+# Optional local-only reconstruction (requires every exact-hash dependency locally):
+.venv/bin/toolframe-backup restore ./backups/backup-<id>.zip --destination ./offline-recovered-app --offline --wheelhouse ./wheelhouse
+```
+
+The CLI prints nonsecret JSON summaries; errors use exit code 2 and interruption
+uses 130. New backup directories and restored directories have mode 0700. Archive
+files and restored payload files have mode 0600; uv sets reconstructed environment
+file modes. Existing backup directories must already have
+mode 0700. Restore requires a new destination with an existing parent directory;
+it never replaces an existing home, including an empty directory.
+Supported restore paths include spaces and Unicode. Paths containing quotes,
+backslashes or control characters are rejected before staging.
+File URI wheel locators encode spaces, Unicode and URI delimiters such as `#`, `?`
+and `%`; direct wheel paths retain their filesystem spelling.
+
+To install the catalog in an existing application, declare the plugin and its
+required destination together in `app/toolframe.toml`. Core resolves the package
+from PyPI; replace the destination with your operator-owned absolute backup path:
+
+```toml
+[plugins.backup]
+source = "pypi:toolframe-backup==0.1.0"
+enabled = true
+
+[plugins.backup.config]
+destination = "/srv/toolframe-backups"
+retention_keep = 10
+```
+
+```sh
+toolframe-core --home ./app plan
+toolframe-core --home ./app apply --plan-id <plan-id-from-the-plan-output>
+```
+
+An installed Dashboard or MCP provider consumes the plugin's ordinary resources.
+Grant `backup.read` to catalog readers. Verification and retention actions require
+the built-in `system.plugins.manage` (Manage plugins) operator permission.
+See the [catalog guide](src/toolframe_backup/docs/usage.md) for its service methods,
+verification records and explicit retention workflow.
+
+## Support limits
+
+- Version 1 supports local in-home files and local SQLite stores accepted by Core's
+  stopped maintenance inventory. Live or uncertain workers, pending recovery,
+  external SQL and external attachments are rejected by Core. S3 and other remote
+  archive destinations are not implemented.
+- Archives are **unencrypted** and contain private keys, configuration and database
+  contents in their payloads. Store them in an operator-controlled local directory.
+  The public manifest contains identity, hashes, store ownership, retained-key
+  requirements and dependency prerequisites, without credential URLs or key bytes.
+- SHA-256 checks detect corruption. They are not signatures and do not authenticate
+  an archive against an attacker who can replace both payload and manifest.
+- Offline means the source host is stopped and the CLI needs no running application.
+  Restore reconstructs omitted backend/UI environments with uv from protected original
+  exact pylocks before reporting `ready: true`. It uses the final absolute directory
+  under Core's public application lock so console-script shebangs remain valid. Missing
+  dependency wheels require exact-hash wheels from a supplied wheelhouse or network;
+  an air-gapped restart is not guaranteed. uv performs locked dependency acquisition;
+  the CLI has no independent downloader. `--offline` forbids network acquisition and
+  `--wheelhouse` supplies local candidate wheels. Recovery requires the original Python
+  implementation, OS and machine architecture. A recorded two-component Python
+  version requires the same major/minor; a recorded three-component version requires
+  the exact patch too. The complete operator interpreter is checked against
+  Requires-Python, environment markers and wheel tags before publication. Reconstruction
+  requires compatible exact-hash wheels and supports at most 100 distinct environments;
+  source builds are disabled. Subprocess output is suppressed to protect credentials.
+  A failed reconstruction removes only the new destination created by that restore.
+- A recovered clone retains the application ID and composition. Do not concurrently
+  run it with another copy using the same external identity. External state is outside
+  the supported recovery scope.
+- Atomic restoration is supported on macOS and Linux. Default limits are 10,000
+  files, 512 MiB per payload file, 2 GiB total payload, 4 MiB manifest, 3 GiB archive,
+  16 MiB protected environment payload and a maximum decompression ratio of 200.
+  ZIP central-directory size/count are checked before indexing. The catalog scans at
+  most 1,000 archives.
+
+See the [archive architecture](docs/architecture.md) and
+[offline recovery decision](docs/adr/0001-stopped-recovery-and-directory-catalog.md).
+
+## Development
+
+Place the immutable matching Toolframe wheel set, including SDK, Core and their
+prerequisites, in `build/wheelhouse/` before syncing. The Core wheel must provide the public
+maintenance helpers used above. This library omits a committed `uv.lock` and
+sibling source pins; development resolves dependencies from supplied or published
+wheels.
+
+```sh
+uv sync --no-sources --find-links ./build/wheelhouse --extra operator --extra ui --group dev
+uv run --no-sync pytest
+uv run --no-sync ruff check .
+uv run --no-sync ruff format --check .
+uv build
+```
+
+Package tests cover archive boundaries with mocked Core inventories and guards, and
+include real offline uv reconstruction of local environments in temporary homes.
+Verify stopped-state eligibility, the actual Core lock and restored application,
+Dashboard and client flows separately through an installed application. Package tests
+do not establish remote-store or air-gap support.
+
+Licensed under [Apache-2.0](LICENSE).
+
+For release validation and Trusted Publisher setup, see [releasing](docs/releasing.md).

toolframe_backup-0.1.0/README.md

@@ -0,0 +1,126 @@
+# Toolframe Backup
+
+Toolframe Backup creates recovery archives of cleanly stopped Toolframe applications
+and provides a Dashboard and read-only MCP catalog for a configured local backup
+directory. Its standalone CLI can verify or restore archives even when the source
+application cannot start. The ordinary plugin never snapshots a running application.
+
+## Quick start
+
+Use Python 3.14 or newer. Archive creation
+requires a Core release providing `toolframe_core.maintenance.stopped_application`.
+Restoring recorded environments also requires its public `application_lock` helper.
+Install the operator extra from PyPI:
+
+```sh
+uv venv --python 3.14
+uv pip install 'toolframe-backup[operator]==0.1.0'
+# Stop the application's host and workers cleanly before creating the archive.
+.venv/bin/toolframe-backup create --home ./app --directory ./backups
+.venv/bin/toolframe-backup list --directory ./backups
+.venv/bin/toolframe-backup verify ./backups/backup-<id>.zip
+.venv/bin/toolframe-backup restore ./backups/backup-<id>.zip --destination ./recovered-app
+# Optional local-only reconstruction (requires every exact-hash dependency locally):
+.venv/bin/toolframe-backup restore ./backups/backup-<id>.zip --destination ./offline-recovered-app --offline --wheelhouse ./wheelhouse
+```
+
+The CLI prints nonsecret JSON summaries; errors use exit code 2 and interruption
+uses 130. New backup directories and restored directories have mode 0700. Archive
+files and restored payload files have mode 0600; uv sets reconstructed environment
+file modes. Existing backup directories must already have
+mode 0700. Restore requires a new destination with an existing parent directory;
+it never replaces an existing home, including an empty directory.
+Supported restore paths include spaces and Unicode. Paths containing quotes,
+backslashes or control characters are rejected before staging.
+File URI wheel locators encode spaces, Unicode and URI delimiters such as `#`, `?`
+and `%`; direct wheel paths retain their filesystem spelling.
+
+To install the catalog in an existing application, declare the plugin and its
+required destination together in `app/toolframe.toml`. Core resolves the package
+from PyPI; replace the destination with your operator-owned absolute backup path:
+
+```toml
+[plugins.backup]
+source = "pypi:toolframe-backup==0.1.0"
+enabled = true
+
+[plugins.backup.config]
+destination = "/srv/toolframe-backups"
+retention_keep = 10
+```
+
+```sh
+toolframe-core --home ./app plan
+toolframe-core --home ./app apply --plan-id <plan-id-from-the-plan-output>
+```
+
+An installed Dashboard or MCP provider consumes the plugin's ordinary resources.
+Grant `backup.read` to catalog readers. Verification and retention actions require
+the built-in `system.plugins.manage` (Manage plugins) operator permission.
+See the [catalog guide](src/toolframe_backup/docs/usage.md) for its service methods,
+verification records and explicit retention workflow.
+
+## Support limits
+
+- Version 1 supports local in-home files and local SQLite stores accepted by Core's
+  stopped maintenance inventory. Live or uncertain workers, pending recovery,
+  external SQL and external attachments are rejected by Core. S3 and other remote
+  archive destinations are not implemented.
+- Archives are **unencrypted** and contain private keys, configuration and database
+  contents in their payloads. Store them in an operator-controlled local directory.
+  The public manifest contains identity, hashes, store ownership, retained-key
+  requirements and dependency prerequisites, without credential URLs or key bytes.
+- SHA-256 checks detect corruption. They are not signatures and do not authenticate
+  an archive against an attacker who can replace both payload and manifest.
+- Offline means the source host is stopped and the CLI needs no running application.
+  Restore reconstructs omitted backend/UI environments with uv from protected original
+  exact pylocks before reporting `ready: true`. It uses the final absolute directory
+  under Core's public application lock so console-script shebangs remain valid. Missing
+  dependency wheels require exact-hash wheels from a supplied wheelhouse or network;
+  an air-gapped restart is not guaranteed. uv performs locked dependency acquisition;
+  the CLI has no independent downloader. `--offline` forbids network acquisition and
+  `--wheelhouse` supplies local candidate wheels. Recovery requires the original Python
+  implementation, OS and machine architecture. A recorded two-component Python
+  version requires the same major/minor; a recorded three-component version requires
+  the exact patch too. The complete operator interpreter is checked against
+  Requires-Python, environment markers and wheel tags before publication. Reconstruction
+  requires compatible exact-hash wheels and supports at most 100 distinct environments;
+  source builds are disabled. Subprocess output is suppressed to protect credentials.
+  A failed reconstruction removes only the new destination created by that restore.
+- A recovered clone retains the application ID and composition. Do not concurrently
+  run it with another copy using the same external identity. External state is outside
+  the supported recovery scope.
+- Atomic restoration is supported on macOS and Linux. Default limits are 10,000
+  files, 512 MiB per payload file, 2 GiB total payload, 4 MiB manifest, 3 GiB archive,
+  16 MiB protected environment payload and a maximum decompression ratio of 200.
+  ZIP central-directory size/count are checked before indexing. The catalog scans at
+  most 1,000 archives.
+
+See the [archive architecture](docs/architecture.md) and
+[offline recovery decision](docs/adr/0001-stopped-recovery-and-directory-catalog.md).
+
+## Development
+
+Place the immutable matching Toolframe wheel set, including SDK, Core and their
+prerequisites, in `build/wheelhouse/` before syncing. The Core wheel must provide the public
+maintenance helpers used above. This library omits a committed `uv.lock` and
+sibling source pins; development resolves dependencies from supplied or published
+wheels.
+
+```sh
+uv sync --no-sources --find-links ./build/wheelhouse --extra operator --extra ui --group dev
+uv run --no-sync pytest
+uv run --no-sync ruff check .
+uv run --no-sync ruff format --check .
+uv build
+```
+
+Package tests cover archive boundaries with mocked Core inventories and guards, and
+include real offline uv reconstruction of local environments in temporary homes.
+Verify stopped-state eligibility, the actual Core lock and restored application,
+Dashboard and client flows separately through an installed application. Package tests
+do not establish remote-store or air-gap support.
+
+Licensed under [Apache-2.0](LICENSE).
+
+For release validation and Trusted Publisher setup, see [releasing](docs/releasing.md).

toolframe_backup-0.1.0/docs/adr/0001-stopped-recovery-and-directory-catalog.md

@@ -0,0 +1,34 @@
+# ADR 0001: Stopped recovery and a directory catalog
+
+Status: accepted
+
+## Context
+
+A useful recovery archive must bind configuration, captured artifacts, journal locks,
+business data and retained private keys to one application composition. Copying a live
+host's home can mix generations and transactions. A recovery tool must also work when
+the application's plugin runtime cannot start.
+
+## Decision
+
+Creation is a standalone operator command using Core's public stopped maintenance
+context. Core owns layout and eligibility, while Backup owns archives, bounded
+verification, restoration into a new home and local retention. Ordinary plugin
+resources expose a directory catalog and guide operators through the stopped workflow.
+The configured directory provides catalog truth; previews and verification observations
+can be rebuilt without coupling recovery to a SQL provider, Jobs or Audit.
+
+Version 1 accepts only local files and SQLite stores inside the application home.
+Archives retain the application identity and exact dependency prerequisites; omitted
+runtime environments are reconstructed at the final path under Core's public lock,
+using protected original exact pylocks before recovery is declared ready. Rehydration can require a network
+or a prepared wheelhouse. Archive encryption and signatures are deferred, so operator
+filesystem permissions protect confidentiality and hashes detect corruption only.
+
+## Consequences
+
+The runtime cannot offer a live-backup button. Operators must stop the host cleanly
+before capture, and external storage needs a future explicit consistency contract.
+Recovery remains available without a functioning source application. A restored clone
+must not concurrently reuse the same external identity. Directory scanning costs full
+verification work and is bounded; unknown files remain untouched by retention.