PyPI - hbkit - Versions diffs - 0.5.0__tar.gz → 0.5.2__tar.gz - Mend

hbkit 0.5.0tar.gz → 0.5.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

{hbkit-0.5.0 → hbkit-0.5.2}/CHANGELOG.md RENAMED Viewed

@@ -1,5 +1,22 @@
 # Changelog
+## 0.5.2
+No change to how hbkit reads or restores archives.
+- CI now restores the synthetic test archives on Windows too, with liblz4 built by vcpkg.
+  The README says what that does and doesn't prove.
+- The project page links the new site guides: restoring without a NAS, damaged backups,
+  and Apple silicon Macs.
+- PyPI metadata: the homepage is the site, Python 3.10 to 3.13 are listed, more keywords.
+## 0.5.1
+### Fixed
+- The test suite no longer needs `/bin/bash`, so it runs in Nix and other build sandboxes.
+  The closed-pipe test now closes the pipe itself, before hbk writes anything.
 ## 0.5.0
 ### New

hbkit-0.5.0/README.md → hbkit-0.5.2/PKG-INFO RENAMED Viewed

@@ -1,3 +1,37 @@
+Metadata-Version: 2.5
+Name: hbkit
+Version: 0.5.2
+Summary: Recover files from Synology Hyper Backup (.hbk) archives without Synology software
+Project-URL: Homepage, https://yordilorenzo.github.io/hbkit/
+Project-URL: Documentation, https://yordilorenzo.github.io/hbkit/restore-without-nas/
+Project-URL: Source, https://github.com/YordiLorenzo/hbkit
+Project-URL: Issues, https://github.com/YordiLorenzo/hbkit/issues
+Project-URL: Format spec, https://github.com/YordiLorenzo/hbkit/blob/main/FORMAT.md
+Author-email: YordiLorenzo <yordilorenzo@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: backup,data-recovery,dsm,extract,hbk,hyper-backup,hyper-backup-explorer,hyperbackup,nas,recovery,synology
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Archiving :: Backup
+Classifier: Topic :: System :: Recovery Tools
+Requires-Python: >=3.10
+Requires-Dist: cryptography>=41
+Requires-Dist: pynacl>=1.5
+Requires-Dist: textual>=0.80
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == 'dev'
+Description-Content-Type: text/markdown
 <p align="center">
   <img src="https://raw.githubusercontent.com/YordiLorenzo/hbkit/main/docs/images/banner.png" alt="hbkit: your backup, without the NAS" width="100%">
 </p>
@@ -9,7 +43,7 @@
 Recover files from **Synology Hyper Backup (`.hbk`)** archives without any Synology software.
 Point it at a backup on a local disk, an external drive, or a network mount, browse it as
-a tree, and pull out what you want. Works headless on Linux and macOS, including Apple Silicon, where Synology's
+a tree, and pull out what you want. Works headless on Linux and macOS, including Apple silicon, where Synology's
 own Hyper Backup Explorer is awkward or unavailable.
 Website: **[yordilorenzo.github.io/hbkit](https://yordilorenzo.github.io/hbkit/)**
@@ -23,6 +57,10 @@ hbk-tui /Volumes/Backup                 # browse and select interactively
 hbk /Volumes/Backup get "/Photos/*" ~/restore
 ```
+![hbk doctor, versions and get, run on a test archive](https://raw.githubusercontent.com/YordiLorenzo/hbkit/main/docs/images/demo.gif)
+*Real output on a small test archive that hbkit's own tests build, not a backup from a NAS.*
 ### Other ways to install
 ```sh
@@ -38,6 +76,20 @@ missing library only shows up when you extract something. The Homebrew formula i
 for you. Otherwise: `brew install lz4`, `sudo apt install liblz4-1`, or
 `sudo pacman -S lz4`. Set `HBK_LZ4` if yours lives somewhere unusual.
+### Restore without a NAS
+The step-by-step guide is on the site:
+[Restore a Hyper Backup without a Synology NAS](https://yordilorenzo.github.io/hbkit/restore-without-nas/).
+If Hyper Backup says the backup is corrupted, start with
+[what you can still recover](https://yordilorenzo.github.io/hbkit/damaged-backup/).
+hbkit never writes to the archive. If it is your only copy, copy the whole `.hbk` folder
+to another disk first and run hbkit on the copy.
+Got your files back? [Tell us in Discussions](https://github.com/YordiLorenzo/hbkit/discussions/categories/recovered-with-hbkit).
+To hear about new versions, watch the repo's releases or follow
+[Announcements](https://github.com/YordiLorenzo/hbkit/discussions/categories/announcements).
 ---
 ## Why
@@ -322,6 +374,9 @@ Read this before trusting it with the only copy of anything.
   archive (unencrypted, LZ4, single version, single pool) and a small encrypted one from
   the same DSM version, both verified byte-exact, plus a 7-version encrypted archive from
   Hyper Backup 4.2.2 reported in [#4](https://github.com/YordiLorenzo/hbkit/issues/4).
+  In [#6](https://github.com/YordiLorenzo/hbkit/issues/6), a user restored 465,000 files
+  (754 GB) from a backup on a NAS hit by C3RB3R ransomware: it had locked only small
+  files that hbkit doesn't read.
   Version selection was checked byte-exact on a small two-version encrypted Hyper Backup
   4.2.2 archive (each version's copy of a changed file, by number and by date), and on
   synthetic archives; the version list comes from `Config/version_info.db`, whose layout
@@ -333,8 +388,11 @@ Read this before trusting it with the only copy of anything.
   bytes, which is the one thing a recovery tool must never do.
 - **Whole-file dedup** (`off_virtual_file = -1`, files living in `Pool/file_pool`) is not
   decoded. One file in 501,278 in the reference archive.
-- **Windows is untested for extraction.** CI installs the package and checks that it
-  imports, but no archive has been rebuilt on Windows. Linux and macOS are verified.
+- **Synology C2 is not tested.** Use Hyper Backup Explorer for a backup kept in C2.
+- **Windows: tested on synthetic archives only.** On every push, CI restores plain and
+  encrypted test archives byte-exact on Windows, with an `lz4.dll` built by
+  `vcpkg install lz4:x64-windows` and `HBK_LZ4` set to its full path. No archive from a
+  real NAS has been restored on Windows yet. Linux and macOS are verified on real archives.
 ## The format
@@ -355,6 +413,7 @@ offsets. Where the two disagreed, the empirical result won.
 ## Prior art
 - [TeamDman/teamy-hyper-backup-explorer](https://github.com/TeamDman/teamy-hyper-backup-explorer) — independent Rust implementation (MPL-2.0). Its constants agree with what we derived separately.
+- [Callido Restore](https://github.com/Niels-van-Haren-Holding-B-V/callido-restore): a separate macOS app (MIT) that restores `.hbk` archives, started 2026-10-30. We have not reviewed its code.
 - [mistersandman/hyperbackup_decrypt](https://github.com/mistersandman/hyperbackup_decrypt) — 2016 Python 2 script, and the only public reference for the **encrypted** variant.
 ## Development

hbkit-0.5.0/PKG-INFO → hbkit-0.5.2/README.md RENAMED Viewed

@@ -1,32 +1,3 @@
-Metadata-Version: 2.5
-Name: hbkit
-Version: 0.5.0
-Summary: Recover files from Synology Hyper Backup (.hbk) archives without Synology software
-Project-URL: Homepage, https://github.com/YordiLorenzo/hbkit
-Project-URL: Source, https://github.com/YordiLorenzo/hbkit
-Project-URL: Issues, https://github.com/YordiLorenzo/hbkit/issues
-Project-URL: Format spec, https://github.com/YordiLorenzo/hbkit/blob/main/FORMAT.md
-Author-email: YordiLorenzo <yordilorenzo@gmail.com>
-License-Expression: MIT
-License-File: LICENSE
-Keywords: backup,data-recovery,dsm,extract,hbk,hyper-backup,nas,recovery,synology
-Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Console
-Classifier: Intended Audience :: End Users/Desktop
-Classifier: Intended Audience :: System Administrators
-Classifier: Operating System :: MacOS
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: System :: Archiving :: Backup
-Classifier: Topic :: System :: Recovery Tools
-Requires-Python: >=3.10
-Requires-Dist: cryptography>=41
-Requires-Dist: pynacl>=1.5
-Requires-Dist: textual>=0.80
-Provides-Extra: dev
-Requires-Dist: pytest>=7; extra == 'dev'
-Description-Content-Type: text/markdown
 <p align="center">
   <img src="https://raw.githubusercontent.com/YordiLorenzo/hbkit/main/docs/images/banner.png" alt="hbkit: your backup, without the NAS" width="100%">
 </p>
@@ -38,7 +9,7 @@ Description-Content-Type: text/markdown
 Recover files from **Synology Hyper Backup (`.hbk`)** archives without any Synology software.
 Point it at a backup on a local disk, an external drive, or a network mount, browse it as
-a tree, and pull out what you want. Works headless on Linux and macOS, including Apple Silicon, where Synology's
+a tree, and pull out what you want. Works headless on Linux and macOS, including Apple silicon, where Synology's
 own Hyper Backup Explorer is awkward or unavailable.
 Website: **[yordilorenzo.github.io/hbkit](https://yordilorenzo.github.io/hbkit/)**
@@ -52,6 +23,10 @@ hbk-tui /Volumes/Backup                 # browse and select interactively
 hbk /Volumes/Backup get "/Photos/*" ~/restore
 ```
+![hbk doctor, versions and get, run on a test archive](https://raw.githubusercontent.com/YordiLorenzo/hbkit/main/docs/images/demo.gif)
+*Real output on a small test archive that hbkit's own tests build, not a backup from a NAS.*
 ### Other ways to install
 ```sh
@@ -67,6 +42,20 @@ missing library only shows up when you extract something. The Homebrew formula i
 for you. Otherwise: `brew install lz4`, `sudo apt install liblz4-1`, or
 `sudo pacman -S lz4`. Set `HBK_LZ4` if yours lives somewhere unusual.
+### Restore without a NAS
+The step-by-step guide is on the site:
+[Restore a Hyper Backup without a Synology NAS](https://yordilorenzo.github.io/hbkit/restore-without-nas/).
+If Hyper Backup says the backup is corrupted, start with
+[what you can still recover](https://yordilorenzo.github.io/hbkit/damaged-backup/).
+hbkit never writes to the archive. If it is your only copy, copy the whole `.hbk` folder
+to another disk first and run hbkit on the copy.
+Got your files back? [Tell us in Discussions](https://github.com/YordiLorenzo/hbkit/discussions/categories/recovered-with-hbkit).
+To hear about new versions, watch the repo's releases or follow
+[Announcements](https://github.com/YordiLorenzo/hbkit/discussions/categories/announcements).
 ---
 ## Why
@@ -351,6 +340,9 @@ Read this before trusting it with the only copy of anything.
   archive (unencrypted, LZ4, single version, single pool) and a small encrypted one from
   the same DSM version, both verified byte-exact, plus a 7-version encrypted archive from
   Hyper Backup 4.2.2 reported in [#4](https://github.com/YordiLorenzo/hbkit/issues/4).
+  In [#6](https://github.com/YordiLorenzo/hbkit/issues/6), a user restored 465,000 files
+  (754 GB) from a backup on a NAS hit by C3RB3R ransomware: it had locked only small
+  files that hbkit doesn't read.
   Version selection was checked byte-exact on a small two-version encrypted Hyper Backup
   4.2.2 archive (each version's copy of a changed file, by number and by date), and on
   synthetic archives; the version list comes from `Config/version_info.db`, whose layout
@@ -362,8 +354,11 @@ Read this before trusting it with the only copy of anything.
   bytes, which is the one thing a recovery tool must never do.
 - **Whole-file dedup** (`off_virtual_file = -1`, files living in `Pool/file_pool`) is not
   decoded. One file in 501,278 in the reference archive.
-- **Windows is untested for extraction.** CI installs the package and checks that it
-  imports, but no archive has been rebuilt on Windows. Linux and macOS are verified.
+- **Synology C2 is not tested.** Use Hyper Backup Explorer for a backup kept in C2.
+- **Windows: tested on synthetic archives only.** On every push, CI restores plain and
+  encrypted test archives byte-exact on Windows, with an `lz4.dll` built by
+  `vcpkg install lz4:x64-windows` and `HBK_LZ4` set to its full path. No archive from a
+  real NAS has been restored on Windows yet. Linux and macOS are verified on real archives.
 ## The format
@@ -384,6 +379,7 @@ offsets. Where the two disagreed, the empirical result won.
 ## Prior art
 - [TeamDman/teamy-hyper-backup-explorer](https://github.com/TeamDman/teamy-hyper-backup-explorer) — independent Rust implementation (MPL-2.0). Its constants agree with what we derived separately.
+- [Callido Restore](https://github.com/Niels-van-Haren-Holding-B-V/callido-restore): a separate macOS app (MIT) that restores `.hbk` archives, started 2026-10-30. We have not reviewed its code.
 - [mistersandman/hyperbackup_decrypt](https://github.com/mistersandman/hyperbackup_decrypt) — 2016 Python 2 script, and the only public reference for the **encrypted** variant.
 ## Development

{hbkit-0.5.0 → hbkit-0.5.2}/pyproject.toml RENAMED Viewed

@@ -4,15 +4,15 @@ build-backend = "hatchling.build"
 [project]
 name = "hbkit"
-version = "0.5.0"
+version = "0.5.2"
 description = "Recover files from Synology Hyper Backup (.hbk) archives without Synology software"
 readme = "README.md"
 requires-python = ">=3.10"
 license = "MIT"
 license-files = ["LICENSE"]
 authors = [{ name = "YordiLorenzo", email = "yordilorenzo@gmail.com" }]
-keywords = ["synology", "hyper-backup", "hbk", "backup", "recovery",
-            "data-recovery", "nas", "dsm", "extract"]
+keywords = ["synology", "hyper-backup", "hyperbackup", "hyper-backup-explorer", "hbk",
+            "backup", "recovery", "data-recovery", "nas", "dsm", "extract"]
 classifiers = [
   "Development Status :: 4 - Beta",
   "Environment :: Console",
@@ -21,6 +21,10 @@ classifiers = [
   "Operating System :: MacOS",
   "Operating System :: POSIX :: Linux",
   "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Topic :: System :: Archiving :: Backup",
   "Topic :: System :: Recovery Tools",
 ]
@@ -30,7 +34,8 @@ dependencies = ["textual>=0.80", "pynacl>=1.5", "cryptography>=41"]
 dev = ["pytest>=7"]
 [project.urls]
-Homepage = "https://github.com/YordiLorenzo/hbkit"
+Homepage = "https://yordilorenzo.github.io/hbkit/"
+Documentation = "https://yordilorenzo.github.io/hbkit/restore-without-nas/"
 Source = "https://github.com/YordiLorenzo/hbkit"
 Issues = "https://github.com/YordiLorenzo/hbkit/issues"
 "Format spec" = "https://github.com/YordiLorenzo/hbkit/blob/main/FORMAT.md"

{hbkit-0.5.0 → hbkit-0.5.2}/src/hbkit/__init__.py RENAMED Viewed

@@ -1,6 +1,6 @@
 """hbkit - recover files from Synology Hyper Backup (.hbk) archives without Synology software."""
-__version__ = "0.5.0"
+__version__ = "0.5.2"
 from .archive import (Archive, NeedPassword, UnsupportedArchive,  # noqa: F401
                       find_archive_root, is_archive)

{hbkit-0.5.0 → hbkit-0.5.2}/tests/test_hbkit.py RENAMED Viewed

@@ -1380,15 +1380,17 @@ def test_unusual_digits_are_a_usage_error(tmp_path):
     assert r.returncode == 2 and "Traceback" not in r.stderr, r.stderr
-@pytest.mark.skipif(sys.platform == "win32", reason="needs bash; see the in-process pipe test")
+@pytest.mark.skipif(sys.platform == "win32",
+                    reason="a closed pipe is EINVAL there; see the in-process pipe test")
 def test_a_closed_pipe_is_not_an_internal_error(tmp_path):
     root, _ = _three_versions(tmp_path)
     env = {**os.environ, "HBK_CACHE": str(tmp_path / "cache")}
-    p = subprocess.run(f'"{sys.executable}" -m hbkit.cli "{root}" list / | head -c 1 >/dev/null; '
-                       'exit ${PIPESTATUS[0]}', shell=True, executable="/bin/bash",
-                       capture_output=True, text=True, env=env)
-    assert "Traceback" not in p.stderr and "please report" not in p.stderr, p.stderr
-    assert p.returncode == 0, p.stderr                       # list: the reader had enough
+    p = subprocess.Popen([sys.executable, "-m", "hbkit.cli", str(root), "list", "/"],
+                         stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env)
+    p.stdout.close()                     # the reader is gone before hbk writes a byte
+    err = p.stderr.read().decode()
+    assert p.wait(timeout=60) == 0, err                      # list: the reader had enough
+    assert "Traceback" not in err and "please report" not in err, err
 # ------------------------------------------------------------- review round 3