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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_dir_snapshot-0.2.1.tar.gz
Algorithm Hash digest
SHA256 413a213dbc028a8a197ab553070afc464c5923d672885d88cd7901b91ca90f40
MD5 40507ddd009a7dc978675dab1517e5ea
BLAKE2b-256 348a339dc05750e122656c5a12567032b256f06036e802f43828403dc4a37d94

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_dir_snapshot-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 49e6aa066dd0bfdf58a846bcef1d89409f2a7cf19a83fbe7c31458338f6ad3fa
MD5 acbf05f7ca3db5405b61b0e04e0b6393
BLAKE2b-256 6c014572de1406badda4b610d89e828c206db189e5142aa1966e903113f1c079

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