Skip to main content

Filesystem state snapshots with diff comparison

Project description

philiprehberger-dir-snapshot

Tests PyPI version License

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")

API

  • snapshot(path, hash_mode="sha256", include=None, exclude=None) — Create a snapshot
  • Snapshot.diff(other) — Compare two snapshots, returns SnapshotDiff
  • Snapshot.to_json(path) / Snapshot.from_json(path) — Serialize/deserialize
  • SnapshotDiff.summary() — Human-readable diff summary

Development

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

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

philiprehberger_dir_snapshot-0.1.6.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_dir_snapshot-0.1.6-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_dir_snapshot-0.1.6.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_dir_snapshot-0.1.6.tar.gz
Algorithm Hash digest
SHA256 a73e3384e2a6e3f07017edfe85e7db07cc50befcda3814e868982cc470135049
MD5 4caef2749e09173c94004d577eba6953
BLAKE2b-256 f5c4686684f065df1c1b315e4a15b8925ede4bdf3b3821ff17882c5d1cbd5130

See more details on using hashes here.

File details

Details for the file philiprehberger_dir_snapshot-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_dir_snapshot-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5ac00673995107316d4ea24b51b22d511a401b1c673267ee2c19e74a33da6c54
MD5 3668c72ca64abf240f9098b1292e098d
BLAKE2b-256 1862ea24581508e47fdf327ff5438897f4202f41f8e2f80d5e11a2e60879d001

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page