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.2.0.tar.gz (5.4 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.2.0-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_dir_snapshot-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d699eb79949249e209d4cf41d14d2b9b036af59e2741e838e6dfe34f6dfa6373
MD5 6ce6093a0c38e33e3c02e4e55af59a50
BLAKE2b-256 83614cda9e409880b8fdf5449422d711d29a0cb670e56a636625d3fe7f4d87de

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_dir_snapshot-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 25d7fcb435687661caa97d9bd9378d493b8bd8f22052afec283aac3f39b29aa4
MD5 68d6eaf27f5a0662ab8cd88598f0f16d
BLAKE2b-256 bca6fc0a3acc93ec17fea451094583d47c368cb462c5a4d67ab637ca2b5fa3b8

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