dar-backup 0.7.1__tar.gz → 0.8.0__tar.gz

{dar_backup-0.7.1/src/dar_backup → dar_backup-0.8.0}/Changelog.md

@@ -1,7 +1,33 @@
 <!-- markdownlint-disable MD024 -->
 # dar-backup Changelog
 
-## v2-beta-0.6.21 - not yet released
+## v2-beta-0.8.0 - 2025-06-13
+
+Github link: [v2-beta-0.8.0](https://github.com/per2jensen/dar-backup/tree/v2-beta-0.8.0/v2)
+
+### Added
+
+- Modified clone dashboard generator to produce easier to read dashboard and be more robust.
+- Dir_traversal sanitation: clean_log.py now only accepts files in configured log directory to `--file` option.
+
+## v2-beta-0.7.2 - 2025-06-07
+
+Github link: [v2-beta-0.7.2](https://github.com/per2jensen/dar-backup/tree/v2-beta-0.7.2/v2)
+
+### Added
+
+- Refactored build system, so all dependencies are kept in `pyproject.toml`. The dependencies are separated  into dev, packaging and delivery phases.
+- Use `build.sh` to setup pytest environment in Github workflow.
+
+  - Do the same to get a development environment going.
+
+- Added 2 new optional params to control log file roll.
+- Enrolling into [Snyk code checker](https://snyk.io/code-checker/) and learning how to work with it.
+  
+  - Snyk helped pointing out vulnerable versions of some packages used.
+  - Input sanitation started, there is room for improvement.
+
+## v2-beta-0.7.1 - 2025-05-22
 
 Github link: [v2-beta-0.7.1](https://github.com/per2jensen/dar-backup/tree/v2-beta-0.7.1/v2)
 
@@ -24,9 +50,9 @@ Github link: [v2-beta-0.7.1](https://github.com/per2jensen/dar-backup/tree/v2-be
 - Action + program to capture cloning stats and store them in v2/doc directory. Includes a badge.
 
   -- annotate new daily max number of clones
-  -- Celebration badge when number of clones numbers are hit (just for fun)
+  -- Celebration badge when certain clones numbers are hit (just for fun)
 
-- Action + program to generate 12weeks cloning dashboard (a PNG) with annotation
+- Action + program to generate 12 weeks cloning dashboard (a PNG) with annotation
 - Tweaked the auto completion setup in .bashrc, it stopped working for me unknown reasons (needs some looking into)
 - --verbose now affects the startup banner. Now it is printed only if --verbose is given
 

{dar_backup-0.7.1 → dar_backup-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dar-backup
-Version: 0.7.1
+Version: 0.8.0
 Summary: A script to do full, differential and incremental backups using dar.     Some files are restored from the backups during verification, after which par2 redundancy files are created.     The script also has a cleanup feature to remove old backups and par2 files.
 Project-URL: GPG Public Key, https://keys.openpgp.org/search?q=dar-backup@pm.me
 Project-URL: Homepage, https://github.com/per2jensen/dar-backup/tree/main/v2
@@ -693,6 +693,27 @@ Requires-Dist: argcomplete>=3.6.2
 Requires-Dist: inputimeout>=1.0.4
 Requires-Dist: jinja2>=3.1.6
 Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: anyio>=4.4.0; extra == 'dev'
+Requires-Dist: black>=25.1.0; extra == 'dev'
+Requires-Dist: coverage>=7.8.2; extra == 'dev'
+Requires-Dist: h11>=0.16.0; extra == 'dev'
+Requires-Dist: httpcore>=0.17.3; extra == 'dev'
+Requires-Dist: matplotlib>=3.10.3; extra == 'dev'
+Requires-Dist: pandas>=2.3.0; extra == 'dev'
+Requires-Dist: psutil>=7.0.0; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov>=6.1.1; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.4.0; extra == 'dev'
+Requires-Dist: pytest>=8.4.0; extra == 'dev'
+Requires-Dist: requests>=2.32.2; extra == 'dev'
+Requires-Dist: wheel>=0.45.1; extra == 'dev'
+Requires-Dist: zipp>=3.19.1; extra == 'dev'
+Provides-Extra: packaging
+Requires-Dist: build>=1.2.2; extra == 'packaging'
+Requires-Dist: hatch>=1.14.1; extra == 'packaging'
+Requires-Dist: hatchling>=1.27.0; extra == 'packaging'
+Requires-Dist: twine>=6.1.0; extra == 'packaging'
 Description-Content-Type: text/markdown
 
 <!-- markdownlint-disable MD024 -->
@@ -700,15 +721,16 @@ Description-Content-Type: text/markdown
 
 **Reliable DAR backups, automated in clean Python**
 
-[![codecov](https://codecov.io/gh/per2jensen/dar-backup/branch/main/graph/badge.svg)](https://codecov.io/gh/per2jensen/dar-backup)
+[![Codecov](https://codecov.io/gh/per2jensen/dar-backup/branch/main/graph/badge.svg)](https://codecov.io/gh/per2jensen/dar-backup)
+[![Snyk Vuln findings](https://snyk.io/test/github/per2jensen/dar-backup/badge.svg)](https://snyk.io/test/github/per2jensen/dar-backup)
 ![CI](https://github.com/per2jensen/dar-backup/actions/workflows/py-tests.yml/badge.svg)
 [![PyPI version](https://img.shields.io/pypi/v/dar-backup.svg)](https://pypi.org/project/dar-backup/)
-[![PyPI total Downloads](https://img.shields.io/badge/dynamic/json?color=blue&label=Total%20Downloads&query=total&url=https%3A%2F%2Fraw.githubusercontent.com%2Fper2jensen%2Fdar-backup%2Fmain%2Fdownloads.json)](https://pypi.org/project/dar-backup/)
+[![PyPI downloads](https://img.shields.io/badge/dynamic/json?color=blue&label=PyPI%20downloads&query=total&url=https%3A%2F%2Fraw.githubusercontent.com%2Fper2jensen%2Fdar-backup%2Fmain%2Fdownloads.json)](https://pypi.org/project/dar-backup/)
 [![# clones](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/per2jensen/dar-backup/main/v2/doc/badges/badge_clones.json)](https://github.com/per2jensen/dar-backup/blob/main/v2/doc/weekly_clones.png)
 [![Milestone](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/per2jensen/dar-backup/main/v2/doc/badges/milestone_badge.json)](https://github.com/per2jensen/dar-backup/blob/main/v2/doc/weekly_clones.png)
 
 The wonderful 'dar' [Disk Archiver](https://github.com/Edrusb/DAR) is used for
-the heavy lifting, together with [parchive](https://github.com/Parchive/par2cmdline) suite in these scripts.
+the heavy lifting, together with the [parchive](https://github.com/Parchive/par2cmdline) suite in these scripts.
 
 This is the `Python` based [**version 2**](https://github.com/per2jensen/dar-backup/tree/main/v2) of `dar-backup`.
 
@@ -770,6 +792,7 @@ This is the `Python` based [**version 2**](https://github.com/per2jensen/dar-bac
   - [Skipping cache directories](#skipping-cache-directories)
   - [Progress bar + current directory](#progress-bar-and-current-directory)
   - [Shell Autocompletion](#shell-autocompletion)
+  - [Easy development setup](#easy-development-setup)
 - [Todo](#todo)
 - [Known Limitations / Edge Cases](#known-limitations--edge-cases)
 - [Reference](#reference)
@@ -904,17 +927,17 @@ Setup the demo configurations and show a few operations
 <br>
 
 ```bash
-# see reference section for options tweaking the install
+# See reference section for options tweaking the install
 demo --install
 
 # create catalog database
 manager --create-db
 
-# do a FULL backup of the installed backup definition called `demo`
+# FULL backup as defined in backup definition `demo`
 dar-backup --full-backup  
 
-# list the contents of the backup
-dar-backup --list-contents $(dar-backup --list |tail -n 1 | cut -d " " -f1)
+# List the contents of the backup
+dar-backup --list-contents demo_FULL_$(date '+%F')
 ```
 
 <details>
@@ -956,7 +979,7 @@ Config file:      /home/user/.config/dar-backup/dar-backup.conf
 
 
 
-(venv) $ dar-backup --list-contents $(dar-backup --list |tail -n 1 | cut -d " " -f1)
+(venv) $ dar-backup --list-contents demo_FULL_$(date '+%F')
 ========== Startup Settings ==========
 dar-backup.py:    0.7.1
 dar path:         /home/user/.local/dar/bin/dar
@@ -984,10 +1007,10 @@ Config file:      /home/user/.config/dar-backup/dar-backup.conf
 Perform a restore and show the restored files
 
 ```bash
-# restore all files in the backup
-dar-backup --restore $(dar-backup --list |tail -n 1 | cut -d " " -f1)  --verbose
+# Restore all files in the backup
+dar-backup --restore demo_FULL_$(date '+%F') --verbose
 
-# prove the files have been restored to directory as configured
+# Prove the files have been restored to directory as configured
 find $HOME/dar-backup/restore
 ```
 
@@ -996,7 +1019,7 @@ find $HOME/dar-backup/restore
 <summary>🎯 --restore details</summary>
 
 ```bash
-(venv) $ dar-backup --verbose --restore $(dar-backup --list |tail -n 1 | cut -d " " -f1)
+(venv) $ dar-backup --restore demo_FULL_$(date '+%F') --verbose
 ========== Startup Settings ==========
 dar-backup.py:    0.7.1
 dar path:         /home/user/.local/dar/bin/dar
@@ -1034,7 +1057,7 @@ PAR2 enabled:     True
 
 > ✅ **Next steps**
 >
-> Tinker with `demo's` options:
+> Play with `demo's` options:
 >
 > - --root-dir      (perhaps $HOME)
 > - --dir-to-backup (perhaps Pictures)
@@ -1169,8 +1192,9 @@ Please review the [Code of Conduct](https://github.com/per2jensen/dar-backup/blo
 
 ## Requirements
 
+- A linux system
 - dar
-- par2
+- parchive (par2)
 - python3
 - python3-venv
 
@@ -1275,27 +1299,25 @@ See section 15 and section 16 in the supplied "LICENSE" file.
 
 ### 2 - configuration
 
-The dar-backup [demo](#demo-options) application can be used to demo how `dar-backup` works.
-It creates some directories, installs a demo configuration file and puts a demo backup definition in place.
+The dar-backup [installer](#installer-options) application can be used to setup the needed directories for `dar-backup` to work.
+It creates necessary directories as prescribed in the config file and optionally creates manager databases.
 
-`demo` is non-destructive and stops if some of the default directories exist.
+`installer` can also add configuration of shell auto completion.
 
-Run `demo`
+Step 1:
 
-```bash
-demo --install
-```
+Create a config file   - [see details on config file](#config-file))
 
-The output is
+Step 2:
 
-```text
-Directories created: `/home/user/dar-backup/` and `/home/user/.config/dar-backup`
-Config file deployed to /home/user/.config/dar-backup/dar-backup.conf
-Default backup definition deployed to /home/user/.config/dar-backup/backup.d/default
-1. Now run `manager --create-db` to create the catalog database.
-2. Then you can run `dar-backup --full-backup` to create a backup.
-3. List backups with `dar-backup --list`
-4. List contents of a backup with `dar-backup --list-contents <backup-name>`
+Create one or more backup definitions - [see details on backup definitions](#backup-definition-example)
+
+Step 3:
+
+Run the installer:
+
+```bash
+installer --config <path to dar-backup.conf> --install-autocompletion
 ```
 
 ### 3 - generate catalog databases
@@ -1310,9 +1332,7 @@ manager --create-db
 
 ### 4 - give dar-backup a spin
 
-The `demo` application has put a demo [backup definition](#backup-definition-example) in place in BACKUP.D_DIR (see [config file](#config-file)).
-
-You are now ready to do backups as configured in the backup definition.
+You are now ready to do backups as configured in your backup definition(s).
 
 Give `dar-backup`a spin:
 
@@ -1322,6 +1342,9 @@ dar-backup --full-backup --verbose
 # list backups
 dar-backup --list
 
+# list contents of a dar backup
+dar-backup --list-contents <TAB>... <choose a backup>
+
 # see some examples on usage
 dar-backup --examples
 
@@ -1360,6 +1383,9 @@ Tilde `~` and environment variables can be used in the paths for various file lo
 ```text
 [MISC]
 LOGFILE_LOCATION=~/.dar-backup.log
+# optional parameters
+# LOGFILE_MAX_BYTES = 26214400  # 25 MB max file size is default, change as neeeded
+# LOGFILE_BACKUP_COUNT = 5      # 5 backup log files is default, change as needed
 MAX_SIZE_VERIFICATION_MB = 20
 MIN_SIZE_VERIFICATION_MB = 1
 NO_FILES_VERIFICATION = 5
@@ -1378,6 +1404,8 @@ TEST_RESTORE_DIR = /tmp/dar-backup/restore/
 
 [AGE]
 # age settings are in days
+# `cleanup` script removes archives and their .par redundancy files if older than configured.
+# `cleanup` does not remove FULL archives, unless specifically told to and a "y" is answered to "are you sure?".
 DIFF_AGE = 100
 INCR_AGE = 40
 
@@ -1533,6 +1561,12 @@ The name of the file is the name of the backup definition.
 
 You can use as many backup definitions as you need.
 
+> Note 👉
+>
+> Environment variables and tilde (~) not allowed here. `dar` does not expand them.
+>
+> See [TODO](#todo)
+
 ```text
  # Switch to ordered selection mode, which means that the following
  # options will be considered top to bottom
@@ -1906,6 +1940,8 @@ These [.darrc](#darrc) settings make `dar` print the current directory being pro
 
 This is very useful in very long running jobs to get an indication that the backup is proceeding normally.
 
+The `dar` output is streamed to the `dar-backup-commands.log` file.
+
 ### Separate log file for command output
 
 Dar-backup's log file is called `dar-backup.log`.
@@ -2067,8 +2103,54 @@ Then reload Zsh:
 source ~/.zshrc
 ```
 
+## Easy development setup
+
+It is very easy to have your own development environment.
+
+```bash
+git clone https://github.com/per2jensen/dar-backup.git
+cd dar-backup/v2
+./build.py
+```
+
+This script:
+
+- Creates a Python virtual environment called `venv`
+- pip install `hatch`
+- pip install the development environment as setup in pyproject.toml
+
+  --
+  
+  ```text
+  dev = [
+  "pytest",
+  "wheel>=0.45.1",
+  "requests>=2.32.2",
+  "coverage>=7.8.2",
+  "pytest>=8.4.0",
+  "pytest-cov>=6.1.1",
+  "psutil>=7.0.0",
+  "pytest-timeout>=2.4.0",
+  "httpcore>=0.17.3",
+  "h11>=0.16.0",
+  "zipp>=3.19.1",
+  "anyio>=4.4.0",
+  "black>=25.1.0"]
+  ```
+
+✅ Your environment is now ready to activate and test!
+
+Activate and run the test suite:
+
+```bash
+source venv/bin/activate # activate the virtual env
+pytest                   # run the test suite
+```
+
 ## Todo
 
+- Perhaps look into pre-processing backup definitions. As `dar` does not expand env vars
+  `dar-backup` could do so and feed the result to `dar`.
 - When run interactively, a progress bar during test and par2 generation would be nice.
 - Look into a way to move the .par2 files away from the `dar` slices, to maximize chance of good redundancy.
 - Add option to dar-backup to use the `dar` option `--fsa-scope none`
@@ -2233,12 +2315,12 @@ Sets up `dar-backup` according to provided config file.
 The installer creates the necessary backup catalog databases if `--create-db` is given.
 
 ```bash
---config                 Sets up `dar-backup`.
---create-db              Create backup catalog databases. Add it to --config
---install-autocompletion Add bash or zsh auto completion - idempotent
---remove-autocompletion  Remove the auto completion from bash or zsh
+--config                 Path to a config file. The configured directories will be created.
+--create-db              Create backup catalog databases. Use this option with `--config`.
+--install-autocompletion Add bash or zsh auto completion - idempotent.
+--remove-autocompletion  Remove the auto completion from bash or zsh.
 -v, --version            Display version and licensing information.
--h, --help               Displays usage info
+-h, --help               Displays usage info.
 ```
 
 ### Demo options
@@ -2258,7 +2340,7 @@ Create directories:
 Sets up demo config files:
 
 - ~/.config/dar-backup/dar-backup.conf
-- ~/.config/dar-backup/backup.d/default
+- ~/.config/dar-backup/backup.d/demo
 
 ```bash
 -i, --install       Sets up `dar-backup`.

{dar_backup-0.7.1 → dar_backup-0.8.0}/README.md

@@ -3,15 +3,16 @@
 
 **Reliable DAR backups, automated in clean Python**
 
-[![codecov](https://codecov.io/gh/per2jensen/dar-backup/branch/main/graph/badge.svg)](https://codecov.io/gh/per2jensen/dar-backup)
+[![Codecov](https://codecov.io/gh/per2jensen/dar-backup/branch/main/graph/badge.svg)](https://codecov.io/gh/per2jensen/dar-backup)
+[![Snyk Vuln findings](https://snyk.io/test/github/per2jensen/dar-backup/badge.svg)](https://snyk.io/test/github/per2jensen/dar-backup)
 ![CI](https://github.com/per2jensen/dar-backup/actions/workflows/py-tests.yml/badge.svg)
 [![PyPI version](https://img.shields.io/pypi/v/dar-backup.svg)](https://pypi.org/project/dar-backup/)
-[![PyPI total Downloads](https://img.shields.io/badge/dynamic/json?color=blue&label=Total%20Downloads&query=total&url=https%3A%2F%2Fraw.githubusercontent.com%2Fper2jensen%2Fdar-backup%2Fmain%2Fdownloads.json)](https://pypi.org/project/dar-backup/)
+[![PyPI downloads](https://img.shields.io/badge/dynamic/json?color=blue&label=PyPI%20downloads&query=total&url=https%3A%2F%2Fraw.githubusercontent.com%2Fper2jensen%2Fdar-backup%2Fmain%2Fdownloads.json)](https://pypi.org/project/dar-backup/)
 [![# clones](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/per2jensen/dar-backup/main/v2/doc/badges/badge_clones.json)](https://github.com/per2jensen/dar-backup/blob/main/v2/doc/weekly_clones.png)
 [![Milestone](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/per2jensen/dar-backup/main/v2/doc/badges/milestone_badge.json)](https://github.com/per2jensen/dar-backup/blob/main/v2/doc/weekly_clones.png)
 
 The wonderful 'dar' [Disk Archiver](https://github.com/Edrusb/DAR) is used for
-the heavy lifting, together with [parchive](https://github.com/Parchive/par2cmdline) suite in these scripts.
+the heavy lifting, together with the [parchive](https://github.com/Parchive/par2cmdline) suite in these scripts.
 
 This is the `Python` based [**version 2**](https://github.com/per2jensen/dar-backup/tree/main/v2) of `dar-backup`.
 
@@ -73,6 +74,7 @@ This is the `Python` based [**version 2**](https://github.com/per2jensen/dar-bac
   - [Skipping cache directories](#skipping-cache-directories)
   - [Progress bar + current directory](#progress-bar-and-current-directory)
   - [Shell Autocompletion](#shell-autocompletion)
+  - [Easy development setup](#easy-development-setup)
 - [Todo](#todo)
 - [Known Limitations / Edge Cases](#known-limitations--edge-cases)
 - [Reference](#reference)
@@ -207,17 +209,17 @@ Setup the demo configurations and show a few operations
 <br>
 
 ```bash
-# see reference section for options tweaking the install
+# See reference section for options tweaking the install
 demo --install
 
 # create catalog database
 manager --create-db
 
-# do a FULL backup of the installed backup definition called `demo`
+# FULL backup as defined in backup definition `demo`
 dar-backup --full-backup  
 
-# list the contents of the backup
-dar-backup --list-contents $(dar-backup --list |tail -n 1 | cut -d " " -f1)
+# List the contents of the backup
+dar-backup --list-contents demo_FULL_$(date '+%F')
 ```
 
 <details>
@@ -259,7 +261,7 @@ Config file:      /home/user/.config/dar-backup/dar-backup.conf
 
 
 
-(venv) $ dar-backup --list-contents $(dar-backup --list |tail -n 1 | cut -d " " -f1)
+(venv) $ dar-backup --list-contents demo_FULL_$(date '+%F')
 ========== Startup Settings ==========
 dar-backup.py:    0.7.1
 dar path:         /home/user/.local/dar/bin/dar
@@ -287,10 +289,10 @@ Config file:      /home/user/.config/dar-backup/dar-backup.conf
 Perform a restore and show the restored files
 
 ```bash
-# restore all files in the backup
-dar-backup --restore $(dar-backup --list |tail -n 1 | cut -d " " -f1)  --verbose
+# Restore all files in the backup
+dar-backup --restore demo_FULL_$(date '+%F') --verbose
 
-# prove the files have been restored to directory as configured
+# Prove the files have been restored to directory as configured
 find $HOME/dar-backup/restore
 ```
 
@@ -299,7 +301,7 @@ find $HOME/dar-backup/restore
 <summary>🎯 --restore details</summary>
 
 ```bash
-(venv) $ dar-backup --verbose --restore $(dar-backup --list |tail -n 1 | cut -d " " -f1)
+(venv) $ dar-backup --restore demo_FULL_$(date '+%F') --verbose
 ========== Startup Settings ==========
 dar-backup.py:    0.7.1
 dar path:         /home/user/.local/dar/bin/dar
@@ -337,7 +339,7 @@ PAR2 enabled:     True
 
 > ✅ **Next steps**
 >
-> Tinker with `demo's` options:
+> Play with `demo's` options:
 >
 > - --root-dir      (perhaps $HOME)
 > - --dir-to-backup (perhaps Pictures)
@@ -472,8 +474,9 @@ Please review the [Code of Conduct](https://github.com/per2jensen/dar-backup/blo
 
 ## Requirements
 
+- A linux system
 - dar
-- par2
+- parchive (par2)
 - python3
 - python3-venv
 
@@ -578,27 +581,25 @@ See section 15 and section 16 in the supplied "LICENSE" file.
 
 ### 2 - configuration
 
-The dar-backup [demo](#demo-options) application can be used to demo how `dar-backup` works.
-It creates some directories, installs a demo configuration file and puts a demo backup definition in place.
+The dar-backup [installer](#installer-options) application can be used to setup the needed directories for `dar-backup` to work.
+It creates necessary directories as prescribed in the config file and optionally creates manager databases.
 
-`demo` is non-destructive and stops if some of the default directories exist.
+`installer` can also add configuration of shell auto completion.
 
-Run `demo`
+Step 1:
 
-```bash
-demo --install
-```
+Create a config file   - [see details on config file](#config-file))
 
-The output is
+Step 2:
 
-```text
-Directories created: `/home/user/dar-backup/` and `/home/user/.config/dar-backup`
-Config file deployed to /home/user/.config/dar-backup/dar-backup.conf
-Default backup definition deployed to /home/user/.config/dar-backup/backup.d/default
-1. Now run `manager --create-db` to create the catalog database.
-2. Then you can run `dar-backup --full-backup` to create a backup.
-3. List backups with `dar-backup --list`
-4. List contents of a backup with `dar-backup --list-contents <backup-name>`
+Create one or more backup definitions - [see details on backup definitions](#backup-definition-example)
+
+Step 3:
+
+Run the installer:
+
+```bash
+installer --config <path to dar-backup.conf> --install-autocompletion
 ```
 
 ### 3 - generate catalog databases
@@ -613,9 +614,7 @@ manager --create-db
 
 ### 4 - give dar-backup a spin
 
-The `demo` application has put a demo [backup definition](#backup-definition-example) in place in BACKUP.D_DIR (see [config file](#config-file)).
-
-You are now ready to do backups as configured in the backup definition.
+You are now ready to do backups as configured in your backup definition(s).
 
 Give `dar-backup`a spin:
 
@@ -625,6 +624,9 @@ dar-backup --full-backup --verbose
 # list backups
 dar-backup --list
 
+# list contents of a dar backup
+dar-backup --list-contents <TAB>... <choose a backup>
+
 # see some examples on usage
 dar-backup --examples
 
@@ -663,6 +665,9 @@ Tilde `~` and environment variables can be used in the paths for various file lo
 ```text
 [MISC]
 LOGFILE_LOCATION=~/.dar-backup.log
+# optional parameters
+# LOGFILE_MAX_BYTES = 26214400  # 25 MB max file size is default, change as neeeded
+# LOGFILE_BACKUP_COUNT = 5      # 5 backup log files is default, change as needed
 MAX_SIZE_VERIFICATION_MB = 20
 MIN_SIZE_VERIFICATION_MB = 1
 NO_FILES_VERIFICATION = 5
@@ -681,6 +686,8 @@ TEST_RESTORE_DIR = /tmp/dar-backup/restore/
 
 [AGE]
 # age settings are in days
+# `cleanup` script removes archives and their .par redundancy files if older than configured.
+# `cleanup` does not remove FULL archives, unless specifically told to and a "y" is answered to "are you sure?".
 DIFF_AGE = 100
 INCR_AGE = 40
 
@@ -836,6 +843,12 @@ The name of the file is the name of the backup definition.
 
 You can use as many backup definitions as you need.
 
+> Note 👉
+>
+> Environment variables and tilde (~) not allowed here. `dar` does not expand them.
+>
+> See [TODO](#todo)
+
 ```text
  # Switch to ordered selection mode, which means that the following
  # options will be considered top to bottom
@@ -1209,6 +1222,8 @@ These [.darrc](#darrc) settings make `dar` print the current directory being pro
 
 This is very useful in very long running jobs to get an indication that the backup is proceeding normally.
 
+The `dar` output is streamed to the `dar-backup-commands.log` file.
+
 ### Separate log file for command output
 
 Dar-backup's log file is called `dar-backup.log`.
@@ -1370,8 +1385,54 @@ Then reload Zsh:
 source ~/.zshrc
 ```
 
+## Easy development setup
+
+It is very easy to have your own development environment.
+
+```bash
+git clone https://github.com/per2jensen/dar-backup.git
+cd dar-backup/v2
+./build.py
+```
+
+This script:
+
+- Creates a Python virtual environment called `venv`
+- pip install `hatch`
+- pip install the development environment as setup in pyproject.toml
+
+  --
+  
+  ```text
+  dev = [
+  "pytest",
+  "wheel>=0.45.1",
+  "requests>=2.32.2",
+  "coverage>=7.8.2",
+  "pytest>=8.4.0",
+  "pytest-cov>=6.1.1",
+  "psutil>=7.0.0",
+  "pytest-timeout>=2.4.0",
+  "httpcore>=0.17.3",
+  "h11>=0.16.0",
+  "zipp>=3.19.1",
+  "anyio>=4.4.0",
+  "black>=25.1.0"]
+  ```
+
+✅ Your environment is now ready to activate and test!
+
+Activate and run the test suite:
+
+```bash
+source venv/bin/activate # activate the virtual env
+pytest                   # run the test suite
+```
+
 ## Todo
 
+- Perhaps look into pre-processing backup definitions. As `dar` does not expand env vars
+  `dar-backup` could do so and feed the result to `dar`.
 - When run interactively, a progress bar during test and par2 generation would be nice.
 - Look into a way to move the .par2 files away from the `dar` slices, to maximize chance of good redundancy.
 - Add option to dar-backup to use the `dar` option `--fsa-scope none`
@@ -1536,12 +1597,12 @@ Sets up `dar-backup` according to provided config file.
 The installer creates the necessary backup catalog databases if `--create-db` is given.
 
 ```bash
---config                 Sets up `dar-backup`.
---create-db              Create backup catalog databases. Add it to --config
---install-autocompletion Add bash or zsh auto completion - idempotent
---remove-autocompletion  Remove the auto completion from bash or zsh
+--config                 Path to a config file. The configured directories will be created.
+--create-db              Create backup catalog databases. Use this option with `--config`.
+--install-autocompletion Add bash or zsh auto completion - idempotent.
+--remove-autocompletion  Remove the auto completion from bash or zsh.
 -v, --version            Display version and licensing information.
--h, --help               Displays usage info
+-h, --help               Displays usage info.
 ```
 
 ### Demo options
@@ -1561,7 +1622,7 @@ Create directories:
 Sets up demo config files:
 
 - ~/.config/dar-backup/dar-backup.conf
-- ~/.config/dar-backup/backup.d/default
+- ~/.config/dar-backup/backup.d/demo
 
 ```bash
 -i, --install       Sets up `dar-backup`.

{dar_backup-0.7.1 → dar_backup-0.8.0}/doc/badges/badge_clones.json

@@ -1,6 +1,6 @@
 {
   "schemaVersion": 1,
   "label": "# clones",
-  "message": "441",
+  "message": "1012",
   "color": "deeppink"
 }

dar_backup-0.8.0/doc/badges/milestone_1000.txt

@@ -0,0 +1 @@
+Reached 1000 clones on 2025-06-13T02:51:59.728578+00:00Z

dar_backup-0.8.0/doc/badges/milestone_500.txt

@@ -0,0 +1 @@
+Reached 500 clones on 2025-05-25T06:40:03.355466+00:00Z

dar_backup-0.8.0/doc/badges/milestone_badge.json

@@ -0,0 +1,6 @@
+{
+  "schemaVersion": 1,
+  "label": "Milestone",
+  "message": "1000 clones \ud83c\udf89\ud83c\udf89",
+  "color": "orange"
+}