dar-backup 0.6.17__py3-none-any.whl → 0.6.19__py3-none-any.whl

{dar_backup-0.6.17.dist-info → dar_backup-0.6.19.dist-info}/METADATA

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: dar-backup
-Version: 0.6.17
+Version: 0.6.19
 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
 Project-URL: Changelog, https://github.com/per2jensen/dar-backup/blob/main/v2/Changelog.md
-Project-URL: Issues, https://github.com/per2jensen/dar-backup/issues
-Author-email: dar-backup <per2jensen@gmail.com>
+Project-URL: Issues, https://github.com/per2jensen
+Author-email: dar-backup <dar-backup@pm.me>
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
         
@@ -688,23 +689,34 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: System :: Archiving :: Backup
 Requires-Python: >=3.9
+Requires-Dist: argcomplete>=3.6.2
 Requires-Dist: inputimeout>=1.0.4
+Requires-Dist: rich>=13.0.0
 Description-Content-Type: text/markdown
 
 <!-- markdownlint-disable MD024 -->
 # Full, differential or incremental backups using 'dar'
 
+[![codecov](https://codecov.io/gh/per2jensen/dar-backup/branch/main/graph/badge.svg)](https://codecov.io/gh/per2jensen/dar-backup)
+[![PyPI monthly downloads](https://img.shields.io/pypi/dm/dar-backup)](https://pypi.org/project/dar-backup/)
+[![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/)
+
 The wonderful 'dar' [Disk Archiver](https://github.com/Edrusb/DAR) is used for
 the heavy lifting, together with the par2 suite in these scripts.
 
 This is the `Python` based **version 2** of `dar-backup`.
 
+## TL;DR
+
+`dar-backup` is a Python-powered CLI for creating and validating full, differential, and incremental backups using dar and par2. Designed for long-term restore integrity, even on user-space filesystems like FUSE.
+
 ## Table of Contents
 
 - [Full, differential or incremental backups using 'dar'](#full-differential-or-incremental-backups-using-dar)
 - [My use case](#my-use-case)
 - [License](#license)
 - [Status](#status)
+  - [GPG Signing key](#gpg-signing-key)
   - [Breaking change in version 0.6.0](#breaking-change-in-version-060)
 - [Homepage - Github](#homepage---github)
 - [Requirements](#requirements)
@@ -720,8 +732,10 @@ This is the `Python` based **version 2** of `dar-backup`.
   - [.darrc](#darrc)
   - [Backup definition](#backup-definition-example)
 - [Systemd examples](#systemctl-examples)
+  - [Generate systemd files](#generate-systemd-files)
   - [Service: dar-back --incremental-backup](#service-dar-backup---incremental-backup)
   - [Timer: dar-back --incremental-backup](#timer-dar-backup---incremental-backup)
+  - [Systemd timer note](#systemd-timer-note)
 - [List contents of an archive](#list-contents-of-an-archive)
 - [dar file selection examples](#dar-file-selection-examples)
   - [Select a directory](#select-a-directory)
@@ -745,14 +759,18 @@ This is the `Python` based **version 2** of `dar-backup`.
   - [.darrc sets -vd -vf (since v0.6.4)](#darrc-sets--vd--vf-since-v064)
   - [Separate log file for command output](#separate-log-file-for-command-output)
   - [Skipping cache directories](#skipping-cache-directories)
+  - [Progress bar + current directory](#progress-bar-and-current-directory)
 - [Todo](#todo)
+- [Known Limitations / Edge Cases](#known-limitations--edge-cases)
 - [Reference](#reference)
+  - [CLI Tools Overview](#cli-tools-overview)
   - [Test coverage report](#test-coverage)
   - [dar-backup](#dar-backup-options)
   - [manager](#manager-options)
   - [cleanup](#cleanup-options)
   - [clean-log](#clean-log-options)
   - [installer](#installer-options)
+  - [dar-backup-systemd](#dar-backup-systemd)
   
 ## My use case
 
@@ -783,6 +801,85 @@ As of August 8, 2024 I am using the alpha versions of `dar-backup` (alpha-0.5.9
 
 As of February 13, 2025, I have changed the status from alpha --> beta, as the featureset is in place and the alphas have worked well for a very long time.
 
+### GPG Signing key
+
+To increase the security and authenticity of dar-backup packages, all releases from v2-beta-0.6.18 onwards will be digitally signed using the GPG key below.
+
+🔐 GPG Signing Key Details
+
+```` text
+Name:        Per Jensen (author of dar-backup)
+Email:       dar-backup@pm.me
+Primary key: 4592 D739 6DBA EFFD 0845  02B8 5CCE C7E1 6814 A36E
+Signing key: B54F 5682 F28D BA36 22D7  8E04 58DB FADB BBAC 1BB1
+Created:     2025-03-29
+Expires:     2030-03-28
+Key type:    ed25519 (primary, SC)  
+Subkeys:     ed25519 (S), ed25519 (A), cv25519 (E)
+````
+
+🔏 Where to Find Release Signatures
+
+PyPI does *Not* host .asc Signature Files
+
+Although the `dar-backup` packages on PyPI are GPG-signed, PyPI itself does **not support uploading** .asc detached signature files alongside `.whl` and `.tar.gz` artifacts.
+
+Therefore, you will not find `.asc` files on PyPI.
+
+✅ Where to Get `.asc` Signature Files
+
+You can always download the signed release artifacts and their `.asc` files from the official GitHub Releases page:
+
+📁 GitHub Releases for `dar-backup`
+
+Each release includes:
+
+- `dar_backup-x.y.z.tar.gz`
+
+- `dar_backup-x.y.z.tar.gz.asc`
+
+- `dar_backup-x.y.z-py3-none-any.whl`
+
+- `dar_backup-x.y.z-py3-none-any.whl.asc`
+
+🔐 How to Verify a Release from GitHub
+
+1. Import the GPG public key:
+
+   ```` bash
+   curl https://keys.openpgp.org/vks/v1/by-fingerprint/4592D7396DBAEFFD084502B85CCEC7E16814A36E | gpg --import
+   ````
+
+2. Download the wheel or tarball and its .asc signature from the GitHub.
+
+3. Run GPG to verify it:
+
+   ```` bash
+   gpg --verify dar_backup-x.y.z.tar.gz.asc dar_backup-x.y.z.tar.gz
+   # or
+   gpg --verify dar_backup-x.y.z-py3-none-any.whl.asc dar_backup-x.y.z-py3-none-any.whl
+   ````
+
+4. If the signature is valid, you'll see:
+
+   ```` text
+   gpg: Good signature from "Per Jensen (author of dar-backup) <dar-backup@pm.me>"
+   ````
+
+🛡️ Reminder: Verify the signing subkey
+
+Only this subkey is used to sign PyPI packages:
+
+```` text
+B54F 5682 F28D BA36 22D7  8E04 58DB FADB BBAC 1BB1
+````
+
+You can view it with:
+
+```` bash
+gpg --list-keys --with-subkey-fingerprints dar-backup@pm.me
+````
+
 ### Breaking change in version 0.6.0
 
 Version 0.6.0 and forwards requires the config variable *COMMAND_TIMEOUT_SECS* in the config file.
@@ -842,6 +939,10 @@ The `cleanup` application deletes DIFF and INCR if the archives are older than t
 
 ## How to run
 
+📦 All official dar-backup releases from v2-beta-0.6.18 are signed with GPG.
+
+See more [here](#gpg-signing-key).
+
 ### 1 - installation
 
 Installation is currently in a venv. These commands are installed in the venv:
@@ -1163,6 +1264,26 @@ You can use as many backup definitions as you need.
 --cache-directory-tagging
 ````
 
+## Generate systemd files
+
+The command `dar-backup-systemd` can generate and optionally install systemd units and timers.
+
+The timers are set as the author uses them, modify to your taste and needs.
+
+Example run:
+
+```` bash
+dar-backup-systemd --venv /home/user/tmp/venv --dar-path /home/user/.local/dar/bin
+Generated dar-full-backup.service and dar-full-backup.timer
+  → Fires on: *-12-30 10:03:00
+Generated dar-diff-backup.service and dar-diff-backup.timer
+  → Fires on: *-*-01 19:03:00
+Generated dar-incr-backup.service and dar-incr-backup.timer
+  → Fires on: *-*-04/3 19:03:00
+Generated dar-clean.service and dar-clean.timer
+  → Fires on: *-*-* 21:07:00
+````
+
 ## Systemctl examples
 
 I have dar-backup scheduled to run via systemd --user settings.
@@ -1185,27 +1306,47 @@ systemctl --user list-timers
 
 ## Service: dar-backup --incremental-backup
 
-File:  dar-inc-backup.service
+This is an exmaple of a systemd user service unit.
 
-```` code
+File:  dar-incr-backup.service
+
+```` bash
+/tmp/test$ dar-backup-systemd --venv '$HOME/programmer/dar-backup.py/venv'  --dar-path '$HOME/.local/dar/bin'
+
+Generated dar-full-backup.service and dar-full-backup.timer
+  → Fires on: *-12-30 10:03:00
+Generated dar-diff-backup.service and dar-diff-backup.timer
+  → Fires on: *-*-01 19:03:00
+Generated dar-incr-backup.service and dar-incr-backup.timer
+  → Fires on: *-*-04/3 19:03:00
+Generated dar-cleanup.service and dar-cleanup.timer
+  → Fires on: *-*-* 21:07:00
+/tmp/test$ 
+(venv) /tmp/test$ 
+(venv) /tmp/test$ cat dar-incr-backup.service 
 [Unit]
-Description=dar-backup INC
+Description=dar-backup INCR
 StartLimitIntervalSec=120
 StartLimitBurst=1
+
 [Service]
 Type=oneshot
 TimeoutSec=infinity
 RemainAfterExit=no
-ExecStart=/bin/bash -c '. /home/user/programmer/dar-backup.py/venv/bin/activate && dar-backup --incremental-backup --verbose'
+
+
+ExecStart=/bin/bash -c 'PATH=$HOME/.local/dar/bin:$PATH && . $HOME/programmer/dar-backup.py/venv/bin/activate && dar-backup -I --verbose --log-stdout'
 ````
 
 ## Timer: dar-backup --incremental-backup
 
-File:  dar-inc-backup.timer
+This is an example of a systemd user timer
+
+File:  dar-incr-backup.timer
 
 ```` code
 [Unit]
-Description=dar-backup INC timer
+Description=dar-backup INCR timer
 
 [Timer]
 OnCalendar=*-*-04/3 19:03:00
@@ -1215,6 +1356,10 @@ Persistent=true
 WantedBy=timers.target
 ````
 
+## systemd timer note
+
+📅 OnCalendar syntax is flexible — you can tweak backup schedules easily. Run systemd-analyze calendar to preview timers.
+
 ## list contents of an archive
 
 ```` bash
@@ -1490,16 +1635,42 @@ The effect is that directories with the [CACHEDIR.TAG](https://bford.info/cached
 
 If the option is not in the backup definition, the cache directories are backed up as any other.
 
-## Todo
+### Progress bar and current directory
+
+If you run dar-backup interactively in a "normal" console on your computer,
+dar-backup displays 2 visual artifacts to show progress.
+
+1. a progress bar that fills up and starts over
+2. a status line showing the directory being backed up. If the directory is big and takes time to backup, the line is not changing, but you will probably know there is a lot to backup.
 
-- `installer` to generate, but not deploy systemd units and timers for:
-  - FULL, DIFF and INCR backups.
-  - cleanup.
+The indicators are not shown if dar-backup is run from systemd or if it is used in terminal multiplexers like `tmux` or `screen`. So no polluting of journald logs.
 
+## Todo
+
+- 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`
 
+## Known Limitations / Edge Cases
+
+Does not currently encrypt data (by design — relies on encrypted storage)
+
+One backup definition per file
+
+.par2 files created for each slice (may be moved in future)
+
 ## Reference
 
+### CLI Tools Overview
+
+| Command               | Description                               |
+|-----------------------|-------------------------------------------|
+| `dar-backup`          | Perform full, differential, or incremental backups with verification and restore testing |
+| `manager`             | Maintain and query catalog databases for archives |
+| `cleanup`             | Remove outdated DIFF/INCR archives (and optionally FULLs) |
+| `clean-log`           | Clean up excessive log output from dar command logs |
+| `installer`           | Set up required directories and default config files |
+| `dar-backup-systemd`  | Generate (and optionally install) systemd timers and services for automated backups |
+
 ### test coverage
 
 Running
@@ -1508,23 +1679,26 @@ Running
 pytest --cov=dar_backup tests/
 ````
 
-gives for version 0.6.17:
+results for a dev version 0.6.19 in this report:
 
 ```` code
 ---------- coverage: platform linux, python 3.12.3-final-0 -----------
-Name                                                              Stmts   Miss  Cover
--------------------------------------------------------------------------------------
-venv/lib/python3.12/site-packages/dar_backup/__about__.py             1      0   100%
-venv/lib/python3.12/site-packages/dar_backup/__init__.py              0      0   100%
-venv/lib/python3.12/site-packages/dar_backup/clean_log.py            68     14    79%
-venv/lib/python3.12/site-packages/dar_backup/cleanup.py             196     53    73%
-venv/lib/python3.12/site-packages/dar_backup/config_settings.py      66      8    88%
-venv/lib/python3.12/site-packages/dar_backup/dar_backup.py          464     99    79%
-venv/lib/python3.12/site-packages/dar_backup/installer.py            46     46     0%
-venv/lib/python3.12/site-packages/dar_backup/manager.py             316     72    77%
-venv/lib/python3.12/site-packages/dar_backup/util.py                162     34    79%
--------------------------------------------------------------------------------------
-TOTAL                                                              1319    326    75%
+Name                                   Stmts   Miss  Cover
+----------------------------------------------------------
+src/dar_backup/__about__.py                1      0   100%
+src/dar_backup/__init__.py                 0      0   100%
+src/dar_backup/clean_log.py               68     13    81%
+src/dar_backup/cleanup.py                193     17    91%
+src/dar_backup/command_runner.py          73      1    99%
+src/dar_backup/config_settings.py         66      8    88%
+src/dar_backup/dar_backup.py             535     56    90%
+src/dar_backup/dar_backup_systemd.py      56      7    88%
+src/dar_backup/installer.py               59      6    90%
+src/dar_backup/manager.py                351     56    84%
+src/dar_backup/rich_progress.py           70      7    90%
+src/dar_backup/util.py                   130     15    88%
+----------------------------------------------------------
+TOTAL                                   1602    186    88%
 ````
 
 ### dar-backup options
@@ -1626,3 +1800,14 @@ Sets up demo config files:
 -v, --version              Display version and licensing information.
 -h, --help                 Displays usage info
 ```
+
+### dar-backup-systemd
+
+Generates and optionally install systemd user service units and timers
+
+``` code
+-h, --help           Show this help message and exit
+--venv VENV          Path to the Python venv with dar-backup
+--dar-path DAR_PATH  Optional path to dar binary's directory
+--install            Install the units to ~/.config/systemd/user
+```

dar_backup-0.6.19.dist-info/RECORD

@@ -0,0 +1,21 @@
+dar_backup/.darrc,sha256=-aerqivZmOsW_XBCh9IfbYTUvw0GkzDSr3Vx4GcNB1g,2113
+dar_backup/Changelog.md,sha256=PbR2JupEHiWdRNP8ApuWEYIrRQEeJQUnlkVR7N4JJHg,8591
+dar_backup/README.md,sha256=PcZQRaBw9i_GbRoA786OFKI0PwY87E7D30UzovWqEQQ,44902
+dar_backup/__about__.py,sha256=1xdEgfhhUWpssnr_9DTiORat5DDv6NUXRtydGkm-Aog,22
+dar_backup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dar_backup/clean_log.py,sha256=uQ_9HomK7RRkskXrgMPbAC84RgNlCFJ8RHL9KHeAMvc,5447
+dar_backup/cleanup.py,sha256=mrpu9xAy6AKcEbjMetscEh-IzJp0xVFObdrwaXncFtA,12712
+dar_backup/command_runner.py,sha256=PQA968EXssSGjSs_16psFkdxRZi9-YK4TrBKFz0ss3k,4455
+dar_backup/config_settings.py,sha256=Rh4T35-w_5tpRAViMfv3YP3GBpG4mQy7Do8cNBzYAR0,4912
+dar_backup/dar-backup.conf,sha256=64O3bGlzqupneT2gVeaETJ1qS6-3Exet9Zto27jgwPQ,897
+dar_backup/dar_backup.py,sha256=Uy0VAFRbOAmZCyZyyEfWuIM4he2WivfQXhKzVGhWbHc,41939
+dar_backup/dar_backup_systemd.py,sha256=oehD_t9CFu0CsMgDWRH-Gt74Ynl1m29yqQEh5Kxv7aw,3807
+dar_backup/installer.py,sha256=fl2LHHWxuXRT814M_zuZh_YqqLk6nuNg9BI9HpLzdUU,4841
+dar_backup/manager.py,sha256=t-CWxvxzhMHCOCU99px6heL3dRmil2JDOyw9PHL96xY,25712
+dar_backup/rich_progress.py,sha256=jTwM-4VlqHHzKqIfyXjL1pWEriobSJwCdN3YXzXzRdo,3105
+dar_backup/util.py,sha256=REZANvqLqczx3MvGszpVaesrpW03NuH_GPGjDllpT4Q,16877
+dar_backup-0.6.19.dist-info/METADATA,sha256=jQwLE815tTEXjKh7l0rUd5SprMF_czZ3QPRXn8TNMnM,86624
+dar_backup-0.6.19.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dar_backup-0.6.19.dist-info/entry_points.txt,sha256=NSCYoG5Dvh1UhvKWOQPgcHdFv4--R4Sre3d9FwJra3E,258
+dar_backup-0.6.19.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+dar_backup-0.6.19.dist-info/RECORD,,

{dar_backup-0.6.17.dist-info → dar_backup-0.6.19.dist-info}/entry_points.txt

@@ -2,5 +2,6 @@
 clean-log = dar_backup.clean_log:main
 cleanup = dar_backup.cleanup:main
 dar-backup = dar_backup.dar_backup:main
+dar-backup-systemd = dar_backup.dar_backup_systemd:main
 installer = dar_backup.installer:main
 manager = dar_backup.manager:main

dar_backup-0.6.17.dist-info/RECORD

@@ -1,17 +0,0 @@
-dar_backup/.darrc,sha256=-aerqivZmOsW_XBCh9IfbYTUvw0GkzDSr3Vx4GcNB1g,2113
-dar_backup/__about__.py,sha256=vii4GL7MExpBC8tvQjQXAsEgfxDE9p438_97wKl4XCc,22
-dar_backup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dar_backup/clean_log.py,sha256=cGhtKYnQJ2ceNQfw5XcCln_WNBasbmlfhO3kRydjDNk,5196
-dar_backup/cleanup.py,sha256=HA8SmwrqDGjfFg4L0CuUQ5N0YJFT6qYbCuvh5mQseF0,13148
-dar_backup/command_runner.py,sha256=74Fsylz1NN-dn8lbdRhkL6LA1r527QJeojBlniGrPuo,2708
-dar_backup/config_settings.py,sha256=Rh4T35-w_5tpRAViMfv3YP3GBpG4mQy7Do8cNBzYAR0,4912
-dar_backup/dar-backup.conf,sha256=64O3bGlzqupneT2gVeaETJ1qS6-3Exet9Zto27jgwPQ,897
-dar_backup/dar_backup.py,sha256=NHBm3zsOhCHnCVoPO0ysD3uMdIQMe62AIdr0yCQ_6BY,37952
-dar_backup/installer.py,sha256=ehp4KSgTc8D9Edsyve5v3NY2MuDbuTFYQQPgou8woV8,4331
-dar_backup/manager.py,sha256=4NeIVgrhIzOS8UePUCdvtswEG55ue0tXWAK7SjD3tpo,21897
-dar_backup/util.py,sha256=6dJXFOjIIZqerbNVFxJZ6gQ4ZVAxyY-RxHcO--9bxwg,8462
-dar_backup-0.6.17.dist-info/METADATA,sha256=-TmZ95gGD9VX1Uz0so4G8sWWX0RE6Aq8qkfKThkDFnY,79979
-dar_backup-0.6.17.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dar_backup-0.6.17.dist-info/entry_points.txt,sha256=Z7P5BUbhtJxo8_nB9qNIMay2eGDbsMKB3Fjwv3GMa4g,202
-dar_backup-0.6.17.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-dar_backup-0.6.17.dist-info/RECORD,,