Repository navigation
feat: --resume, archive README and package restructure (0.1.1) - #10
Merged
Merged
Conversation
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.
This was referenced Nov 14, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Release 0.1.1: adds
--resumeand the generatedBATCHVAULT-README.md, and reorganises the code base.pack --resume/unpack --resumecontinue an interrupted run, andpackwritesBATCHVAULT-README.mdnext to the manifest (--no-readmeturns it off). SeeCHANGELOG.md.core/,archive/,cli/andengines/packages.api.pyis split intocore/api/andcli.pyintocli/parser.py,cli/commands/andcli/_common.py.TYPE_CHECKINGfor annotations, lazy public names inbatchvault/__init__.py).core/data/levels.toml, README text inarchive/templates/*.md.tmpl.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/guides/,testing.mdmerged intodevelopment.md, newdocs/README.md,SUPPORT.md,.gitattributes,.markdownlint-cli2.yaml,sweepito.toml; changelog follows Keep a Changelog and Semantic Versioning.Compatibility
import batchvault as bv, thebatchvaultcommand and the GitHub Action are unchanged. Code that imported internal modules directly (for examplebatchvault.options) must use the new paths (batchvault.core.options). This is noted under "Changed" in the changelog.Notes for review
docs/development.mdthe new features would be0.2.0; the version is set to0.1.1as requested.uv.lockalso changed its format revision (3 to 5) because of the installed uv.Testing
tests/e2e/test_package_e2e.pypass locally.