You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21Lines changed: 21 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,10 +41,31 @@ is only stored on disk one time. If snapshots are deleted and a given hashed con
41
41
then the `--gargbage-collect` flag will prompt `cacheback` to purge these unused hash-named files to recover storage space.
42
42
43
43
## Install
44
+
45
+
## PyPi
44
46
```
45
47
pip install cacheback-snapshot
46
48
```
47
49
50
+
## ZipApp
51
+
Create an executable single-file using python's zipapp feature by running `./scripts/install-zipapp.sh <install_dir>`, for example:
52
+
53
+
```console
54
+
$ ./scripts/install-zipapp.sh ~/.local/bin/
55
+
Processing ./.
56
+
Installing build dependencies ... done
57
+
Getting requirements to build wheel ... done
58
+
Preparing metadata (pyproject.toml) ... done
59
+
Building wheels for collected packages: cacheback-snapshot
60
+
Building wheel for cacheback-snapshot (pyproject.toml) ... done
61
+
Successfully built cacheback-snapshot
62
+
Installing collected packages: cacheback-snapshot
63
+
Successfully installed cacheback-snapshot
64
+
65
+
$ ~/.local/bin/cacheback --help
66
+
usage: python /home/m/.local/bin/cacheback ...
67
+
```
68
+
48
69
## Usage
49
70
>[!NOTE]
50
71
> The first time taking a snapshot will take much longer than subsequent snapshots, since the first run will need to copy any and all files to the snapshot storage directory. The real magic of this tool happens on the *subsequent* snapshots that target mostly the same directories.
0 commit comments