Skip to content

Commit 652c040

Browse files
authored
add zipapp info
Added installation instructions for PyPi and ZipApp.
1 parent ed4c153 commit 652c040

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,31 @@ is only stored on disk one time. If snapshots are deleted and a given hashed con
4141
then the `--gargbage-collect` flag will prompt `cacheback` to purge these unused hash-named files to recover storage space.
4242

4343
## Install
44+
45+
## PyPi
4446
```
4547
pip install cacheback-snapshot
4648
```
4749

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+
4869
## Usage
4970
>[!NOTE]
5071
> 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

Comments
 (0)