Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RhetTbull/dirsnapshot
Diff for directories; create snapshots of directories and compare/diff these to the directory or another snapshot
https://github.com/RhetTbull/dirsnapshot
Last synced: 3 months ago
JSON representation
Diff for directories; create snapshots of directories and compare/diff these to the directory or another snapshot
- Host: GitHub
- URL: https://github.com/RhetTbull/dirsnapshot
- Owner: RhetTbull
- License: mit
- Created: 2022-06-05T15:25:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-19T15:45:16.000Z (over 2 years ago)
- Last Synced: 2024-07-16T14:55:56.793Z (4 months ago)
- Language: Python
- Size: 88.9 KB
- Stars: 8
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# dirsnapshot
## Description
Report differences between a directory and a previous snapshot of the same directory.
This works very similar to [dircmp](https://docs.python.org/3/library/filecmp.html#the-dircmp-class) but it is designed to be used with a directory that is being monitored instead of comparing two existing directories.
This module can be run as a standalone CLI app as `dirsnap` or included in your project as a package.
## Usage
```python
from dirsnapshot import DirDiff, create_snapshot
# snapshot a directory
create_snapshot("/Users/user/Desktop", "/Users/user/Desktop/Desktop.snapshot")
# do some work
...
# compare the current state of the director to the snapshot
dirdiff = DirDiff("/Users/user/Desktop/Desktop.snapshot", "/Users/user/Desktop")
# print report to stdout
dirdiff.report()
# or print report to json
print(dirdiff.json())
```
## Installation
```bash
pip install dirsnapshot
```
## CLI
Installing the `dirsnapshot` package will install a command line tool called `dirsnap` that can be used to create snapshots of directories and compare a directory to an existing snapshot.
```
usage: dirsnap [-h] [--json] [--snapshot DIRECTORY SNAPSHOT_FILE]
[--diff SNAPSHOT_A DIRECTORY_OR_SNAPSHOT_B]
[--descr DESCRIPTION] [--identical] [--ignore REGEX]
[--no-walk]
Compare a directory to a previously saved snapshot or compare two directory
snapshots. You must specify one of --snapshot or --diff. Will show files
added/removed/modified. Files are considered modified if any of mode, uid,
gid, size, or mtime are different.
options:
-h, --help show this help message and exit
--json, -j Output as JSON
--snapshot DIRECTORY SNAPSHOT_FILE, -s DIRECTORY SNAPSHOT_FILE
Create snapshot of DIRECTORY at SNAPSHOT_FILE
--diff SNAPSHOT_A DIRECTORY_OR_SNAPSHOT_B
Diff SNAPSHOT_A and DIRECTORY_OR_SNAPSHOT_B
--descr DESCRIPTION, -d DESCRIPTION
Optional description of snapshot to store with
snapshot for use with --snapshot.
--identical, -I Include identical files in report (always included
with --json)
--ignore REGEX, -i REGEX
Ignore files matching REGEX
--no-walk Don't walk directories
```
For example:
```bash
$ dirsnap --snapshot ~/Desktop/export before.snapshot
Creating snapshot of '/Users/username/Desktop/export' at 'before.snapshot'
Snapshot created at 'before.snapshot'
$ touch ~/Desktop/export/IMG_4548.jpg
$ rm ~/Desktop/export/IMG_4547.jpg
$ touch ~/Desktop/export/new_file.jpg
$ dirsnap --diff before.snapshot ~/Desktop/export
diff '/Users/username/Desktop/export' 2022-06-05T18:38:11.189886 (Snapshot created at 2022-06-05T18:38:11.189886) vs 2022-06-05T18:39:07.225374 (Snapshot created at 2022-06-05T18:39:07.225374)
Added:
/Users/username/Desktop/export/new_file.jpg
Removed:
/Users/username/Desktop/export/IMG_4547.jpg
Modified:
/Users/username/Desktop/export/IMG_4548.jpg
```
## File Comparison
During the `diff` comparison, files are considered equal if all properties of the file are equal. Currently, the properties checked are: is_file, is_dir, mode, uid, gid, size, mtime. If any of these properties are different, the file is considered modified.
## File Format
The snapshot database file is a standard SQLite database. The current schema is:
```sql
CREATE TABLE snapshot (
path TEXT,
is_dir INTEGER,
is_file INTEGER,
st_mode INTEGER,
st_uid INTEGER,
st_gid INTEGER,
st_size INTEGER,
st_mtime INTEGER,
user_data BLOB);
CREATE TABLE _metadata (
description TEXT, source TEXT, version TEXT, created_at DATETIME);
CREATE TABLE about (
description TEXT, directory TEXT, datetime DATETIME);
CREATE INDEX snapshot_path_index ON snapshot (path);
```
You should not need access the database directly however, as the `DirSnapshot` class provides methods to access the necessary information abstracted from the actual database schema.
## Dependencies
No dependencies! This is a pure Python module that uses only the standard Python libraries.