Skip to content

feat: --resume, archive README and package restructure (0.1.1) - #10

Merged
coldsofttech merged 6 commits into
mainfrom
feat/readme-and-resume
Nov 14, 2026
Merged

coldsofttech merged 6 commits into
mainfrom
feat/readme-and-resume

Conversation

@coldsofttech

Copy link
Copy Markdown
Owner

Summary

Release 0.1.1: adds --resume and the generated BATCHVAULT-README.md, and reorganises the code base.

  • New for users: pack --resume / unpack --resume continue an interrupted run, and pack writes BATCHVAULT-README.md next to the manifest (--no-readme turns it off). See CHANGELOG.md.
  • Structure: the flat modules are now core/, archive/, cli/ and engines/ packages. api.py is split into core/api/ and cli.py into cli/parser.py, cli/commands/ and cli/_common.py.
  • Imports: lazy (function-level imports, TYPE_CHECKING for annotations, lazy public names in batchvault/__init__.py).
  • Data out of code: level rules in core/data/levels.toml, README text in archive/templates/*.md.tmpl.
  • Tests: tests/unit/ mirrors the source layout; new native integration tests sit beside the 7-Zip ones; the wheel-contents e2e test covers the new layout and data files.
  • Docs and project files: guides moved to docs/guides/, testing.md merged into development.md, new docs/README.md, SUPPORT.md, .gitattributes, .markdownlint-cli2.yaml, sweepito.toml; changelog follows Keep a Changelog and Semantic Versioning.

Compatibility

import batchvault as bv, the batchvault command and the GitHub Action are unchanged. Code that imported internal modules directly (for example batchvault.options) must use the new paths (batchvault.core.options). This is noted under "Changed" in the changelog.

Notes for review

  • Under the SemVer rules in docs/development.md the new features would be 0.2.0; the version is set to 0.1.1 as requested.
  • uv.lock also changed its format revision (3 to 5) because of the installed uv.

Testing

  • Ruff and mypy are clean.
  • Unit tests, the native and 7-Zip integration tests and tests/e2e/test_package_e2e.py pass locally.
  • The CLI and Docker end-to-end tests and the GitHub Action job were not run locally; CI covers them.

Describes how the archive was made, how to install the same BatchVault
version and the exact unpack/verify commands (with password-file or
public-key options when encrypted or signed). Never contains secrets.
A file is only replaced if it carries the generated marker; --no-readme
(readme=False) turns it off.
Formatting only, no behavior change.
Typing-only changes: annotate containers and optional attributes, narrow
Optional values before use, and widen two signatures to match how they
are called. No behavior change.
pack and unpack keep a JSON Lines journal in the output folder; --resume
continues from it using only the settings recorded there, so no other
options are given and conflicting ones are refused. Finished files are
reused only if the source is unchanged and every volume (or restored
file) still matches its checksum; anything else is redone. unpack never
overwrites or deletes a file it did not write. Passwords and keys are
never stored. No journal is an error.

Also available as resume=True in the Python API, the resume input of the
GitHub Action and in Docker. Interrupting a run now stops starting new
files instead of working through the queue.
Source
- Split the flat modules into core/, archive/, cli/ and engines/ packages.
- Split api.py into core/api/ (packing/, unpacking/, verifying, listing, _common).
- Split cli.py into cli/parser.py, cli/commands/ and cli/_common.py.
- Import lazily: function-level imports and TYPE_CHECKING for annotations, and
  the public names of the package are loaded on first use.
- Move the level rules to core/data/levels.toml and the generated README text to
  archive/templates/*.md.tmpl.

Tests
- Mirror the source layout under tests/unit/ and add native integration tests
  next to the 7-Zip ones under tests/integration/.
- Update the wheel-contents end-to-end test for the new layout and data files.

Docs and project files
- Move the guides to docs/guides/, merge testing.md into development.md and add
  docs/README.md; refresh architecture.md.
- Add SUPPORT.md, .gitattributes, .markdownlint-cli2.yaml and sweepito.toml.
- Follow Keep a Changelog and Semantic Versioning; set the version to 0.1.1.
@coldsofttech
coldsofttech merged commit e879260 into main Nov 14, 2026
24 checks passed
@coldsofttech
coldsofttech deleted the feat/readme-and-resume branch November 14, 2026 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant