philiprehberger-dir-snapshot 0.3.0

Filesystem state snapshots with diff comparison

philiprehberger-dir-snapshot

Filesystem state snapshots with diff comparison.

Installation

pip install philiprehberger-dir-snapshot

Usage

Take a Snapshot

from philiprehberger_dir_snapshot import snapshot

snap = snapshot("./src")
print(f"Found {len(snap.files)} files")

Compare Snapshots

before = snapshot("./src")
# ... make changes ...
after = snapshot("./src")

diff = before.diff(after)
print(diff.summary())

for f in diff.added:
    print(f"+ {f.path}")
for f in diff.removed:
    print(f"- {f.path}")
for f in diff.modified:
    print(f"~ {f.path}")

Save and Load

# Save to JSON
before.to_json("snapshot.json")

# Load later
from philiprehberger_dir_snapshot import Snapshot
restored = Snapshot.from_json("snapshot.json")

Options

# Include only Python files
snap = snapshot("./src", include=["*.py"])

# Exclude build artifacts
snap = snapshot(".", exclude=["__pycache__", "*.pyc", ".git"])

# Use faster hashing (or disable with "none")
snap = snapshot(".", hash_mode="md5")

Verify a Snapshot

Re-check that every file recorded in a snapshot is still on disk and unchanged — useful for backup verification or detecting silent corruption.

snap = snapshot("./backup", hash_mode="sha256")
# ... time passes / backup is restored ...

report = snap.verify()
if report.is_intact:
    print("backup intact")
else:
    print(report.summary())
    for path in report.missing:
        print(f"missing: {path}")
    for path in report.modified:
        print(f"corrupt: {path}")

API

Function / Class	Description
snapshot(path, hash_mode="mtime", include=None, exclude=None)	Create a directory snapshot
Snapshot.diff(other)	Compare two snapshots, returns SnapshotDiff
Snapshot.verify(strict=False)	Re-check stored entries against disk; returns VerifyReport
Snapshot.to_json(path) / Snapshot.from_json(path)	Serialize/deserialize
VerifyReport.is_intact	True when nothing is missing or modified
VerifyReport.verified / .missing / .modified	File path lists
FileEntry	File metadata — .path, .size, .mtime, .hash
SnapshotDiff.has_changes	True if any files were added, removed, or modified
SnapshotDiff.added / .removed / .modified / .unchanged	Lists of file paths
SnapshotDiff.summary()	Human-readable diff summary

Development

pip install -e .
python -m pytest tests/ -v

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT