diff --git a/Development.md b/Development.md new file mode 100644 index 0000000..9f42561 --- /dev/null +++ b/Development.md @@ -0,0 +1,34 @@ +These are instructions if you want to modify zfs-autobackup, or if you want to run zfs-autobackup directly from git. + +## Setting up virtual env + +(this is optional, you can also install the requirements globally) + +```console +psy@ws1:~/zfs_autobackup$ python3 -m venv backupdev +psy@ws1:~/zfs_autobackup$ source backupdev/bin/activate +(backupdev) psy@ws1:~/zfs_autobackup$ pip install -r requirements.txt +psy@ws1 ~/zfs_autobackup % python3 -m venv backupdev +... +``` + +## Running zfs_autobackup + +To run zfs_autobackup you can just access it as a python module: + +```console +(backupdev) psy@ws1:~/zfs_autobackup$ python -m zfs_autobackup.ZfsAutobackup --version +ZfsAutobackup.py v3.2-alpha1 - (c)2021 E.H.Eefting (edwin@datux.nl) +``` + +Same goes for zfs-autoverify: +```console +(backupdev) psy@ws1:~/zfs_autobackup$ python -m zfs_autobackup.ZfsAutoverify --version +ZfsAutoverify.py v3.2-alpha1 - (c)2021 E.H.Eefting (edwin@datux.nl) +``` + + + + + +