dar-backup 0.6.20.1__py3-none-any.whl → 0.7.1__py3-none-any.whl

dar_backup/__about__.py

@@ -1 +1,6 @@
-__version__ = "0.6.20.1"
+__version__ = "0.7.1"
+
+__license__ = '''Licensed under GNU GENERAL PUBLIC LICENSE v3, see the supplied file "LICENSE" for details.
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW, not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See section 15 and section 16 in the supplied "LICENSE" file.'''
+

dar_backup/clean_log.py

@@ -1,4 +1,6 @@
 #!/usr/bin/env python3
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 """
 clean-log.py source code is here: https://github.com/per2jensen/dar-backup/tree/main/v2/src/dar_backup/clean-log.py
 This script is part of dar-backup, a backup solution for Linux using dar and systemd.

dar_backup/cleanup.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """
 cleanup.py source code is here: https://github.com/per2jensen/dar-backup
@@ -37,6 +38,7 @@ from dar_backup.util import setup_logging
 from dar_backup.util import get_logger
 from dar_backup.util import requirements
 from dar_backup.util import show_version
+from dar_backup.util import get_invocation_command_line
 from dar_backup.util import print_aligned_settings
 from dar_backup.util import backup_definition_completer, list_archive_completer
 
@@ -222,6 +224,7 @@ def main():
     start_msgs.append(("cleanup.py:", about.__version__))
 
     logger.info(f"START TIME: {start_time}")
+    logger.debug(f"Command line: {get_invocation_command_line()}")
     logger.debug(f"`args`:\n{args}")
     logger.debug(f"`config_settings`:\n{config_settings}")
 
@@ -234,7 +237,7 @@ def main():
     args.verbose and start_msgs.append(("--cleanup-specific-archives:", args.cleanup_specific_archives)) 
 
     dangerous_keywords = ["--cleanup", "_FULL_"] # TODO: add more dangerous keywords
-    print_aligned_settings(start_msgs, highlight_keywords=dangerous_keywords)
+    print_aligned_settings(start_msgs, highlight_keywords=dangerous_keywords, quiet=not args.verbose)
 
     # run PREREQ scripts
     requirements('PREREQ', config_settings)

dar_backup/command_runner.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 import subprocess
 import logging
 import threading

dar_backup/config_settings.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 import configparser
 from dataclasses import dataclass, field, fields
 from os.path import expandvars, expanduser

dar_backup/dar-backup.conf

@@ -1,6 +1,8 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 # This config file is intended to demo `dar-backup`.
 #
-# The `installer` puts it in ~/.config/dar-backup/dar-backup.conf
+# The `demo` application puts this file in ~/.config/dar-backup/dar-backup.conf
 
 [MISC]
 LOGFILE_LOCATION = ~/dar-backup/dar-backup.log
@@ -13,7 +15,7 @@ NO_FILES_VERIFICATION = 5
 COMMAND_TIMEOUT_SECS = 86400
 
 [DIRECTORIES]
-BACKUP_DIR = ~/dar-backup/backups
+BACKUP_DIR = @@BACKUP_DIR@@
 BACKUP.D_DIR = ~/.config/dar-backup/backup.d/
 TEST_RESTORE_DIR = ~/dar-backup/restore/
 # Optional parameter

dar_backup/dar-backup.conf.j2

@@ -0,0 +1,60 @@
+
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# ------------------------------------------------------------------------
+# Demo of a `dar-backup` configuration file
+# This file was generated by dar-backup's `demo` program.
+# 
+{%- if opts_dict | length > 0 %}
+# Options given to the `demo` program:
+{% endif %}
+{%- if opts_dict.ROOT_DIR -%}
+# --root-dir : {{ opts_dict.ROOT_DIR }}  
+{% endif %}
+{%- if opts_dict.DIR_TO_BACKUP -%}
+# --dir-to-backup : {{ opts_dict.DIR_TO_BACKUP }}  
+{% endif -%}
+{%- if opts_dict.BACKUP_DIR -%}
+# --backup-dir : {{ opts_dict.BACKUP_DIR }}
+{% endif %}
+#
+# Variables used to generate this file:
+# =====================================
+{% for k,v in vars_map|dictsort %}# {{ k }} : {{ v }}
+{% endfor -%}
+# ------------------------------------------------------------------------
+
+[MISC]
+LOGFILE_LOCATION = {{ vars_map.DAR_BACKUP_DIR -}}/dar-backup.log
+MAX_SIZE_VERIFICATION_MB = 2
+MIN_SIZE_VERIFICATION_MB = 0
+NO_FILES_VERIFICATION = 1
+# timeout in seconds for backup, test, restore and par2 operations
+# The author has such `dar` tasks running for 10-15 hours on the yearly backups, so a value of 24 hours is used.
+# If a timeout is not specified when using the CommandRunner, a default timeout of 30 secs is used.
+COMMAND_TIMEOUT_SECS = 86400
+
+[DIRECTORIES]
+BACKUP_DIR = {{ vars_map.BACKUP_DIR }}
+BACKUP.D_DIR = {{ vars_map.BACKUP_D_DIR }}
+TEST_RESTORE_DIR = {{ vars_map.TEST_RESTORE_DIR }}
+# Optional parameter
+# If you want to store the catalog database away from the BACKUP_DIR,  use the MANAGER_DB_DIR variable.
+#MANAGER_DB_DIR = /some/where/else/
+
+[AGE]
+# DIFF and INCR backups are kept for a configured number of days, then deleted by the `cleanuo` 
+# age settings are in days
+DIFF_AGE = 100
+INCR_AGE = 40
+
+[PAR2]
+ERROR_CORRECTION_PERCENT = 5
+ENABLED = True
+
+[PREREQ]
+#SCRIPT_1 = <pre-script 1>
+
+[POSTREQ]
+#SCRIPT_1 = <post-script 1>
+

dar_backup/dar_backup.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-
+# SPDX-License-Identifier: GPL-3.0-or-later
 """
 installer.py source code is here: https://github.com/per2jensen/dar-backup/tree/main/v2/src/dar_backup/installer.py
 This script is part of dar-backup, a backup solution for Linux using dar and systemd.
@@ -51,6 +51,7 @@ from dar_backup.util import BackupError
 from dar_backup.util import RestoreError
 from dar_backup.util import requirements
 from dar_backup.util import show_version
+from dar_backup.util import get_invocation_command_line
 from dar_backup.util import get_binary_info
 from dar_backup.util import print_aligned_settings
 from dar_backup.util import backup_definition_completer, list_archive_completer
@@ -683,12 +684,29 @@ INCR back of a single backup definition in backup.d
 
 
 --selection
-    --selection takes dar selection parameters between a pair of `"`. 
 
-    Example: select file names with this date in file names "2024-07-01" in the
-    directory "path/to/a/dir" where the path is relative to root of the backup.
+    --selection takes dar file selection options inside a quoted string.
+    
+    💡 Shell quoting matters! Always wrap the entire selection string in double quotes to avoid shell splitting. 
+
+    ✅ Use:   --selection="-I '*.NEF'"
+    ❌ Avoid: --selection "-I '*.NEF'" → may break due to how your shell parses it.
+
+    Examples:
+    1)
+    select file names with "Z50_" in file names:
+        python3 dar-backup.py --restore <name of dar archive>  --selection="-I '*Z50_*'"
+    2)
+    Filter out *.xmp files:
+        python3 dar-backup.py --restore <name of dar archive>  --selection="-X '*.xmp'"
+    
+    3)
+    Include all files in a directory:
+        python3 dar-backup.py --restore <name of dar archive>  --selection="-g 'path/to/a/dir'"
 
-    python3 dar-backup.py --restore <name of dar archive>  --selection "-I '*2024-07-01*' -g path/to/a/dir"
+    4)
+    Exclude a directory:
+        python3 dar-backup.py --restore <name of dar archive>  --selection="-P 'path/to/a/dir'"
 
     See dar documentation on file selection: http://dar.linux.free.fr/doc/man/dar.html#COMMANDS%20AND%20OPTIONS
 """
@@ -764,7 +782,7 @@ def main():
     parser.add_argument('--darrc', type=str, help='Optional path to .darrc')
     parser.add_argument('-l', '--list', action='store_true', help="List available archives.").completer = list_archive_completer
     parser.add_argument('--list-contents', help="List the contents of the specified archive.").completer = list_archive_completer
-    parser.add_argument('--selection', help="dar file selection for listing/restoring specific files/directories.")
+    parser.add_argument('--selection', type=str, help="Selection string to pass to 'dar', e.g. --selection=\"-I '*.NEF'\"")
 #    parser.add_argument('-r', '--restore', nargs=1, type=str, help="Restore specified archive.")
     parser.add_argument('-r', '--restore', type=str, help="Restore specified archive.").completer = list_archive_completer
     parser.add_argument('--restore-dir',   type=str, help="Directory to restore files to.")
@@ -847,6 +865,7 @@ def main():
         start_time=int(time())
         start_msgs.append(('dar-backup.py:', about.__version__))
         logger.info(f"START TIME: {start_time}")
+        logger.debug(f"Command line: {get_invocation_command_line()}")
         logger.debug(f"{'`Args`:\n'}{args}")
         logger.debug(f"{'`Config_settings`:\n'}{config_settings}")
         dar_properties = get_binary_info(command='dar')
@@ -858,9 +877,9 @@ def main():
         start_msgs.append(('Config file:', os.path.abspath(args.config_file)))
         start_msgs.append((".darrc location:", args.darrc))
 
-        args.verbose and args.full_backup         and start_msgs.append(("Type of backup:", "FULL"))
-        args.verbose and args.differential_backup and start_msgs.append(("Type of backup:", "DIFF"))
-        args.verbose and args.incremental_backup  and start_msgs.append(("Type of backup:", "INCR"))
+        args.full_backup         and start_msgs.append(("Type of backup:", "FULL"))
+        args.differential_backup and start_msgs.append(("Type of backup:", "DIFF"))
+        args.incremental_backup  and start_msgs.append(("Type of backup:", "INCR"))
         args.verbose and args.backup_definition   and start_msgs.append(("Backup definition:", args.backup_definition))
         if args.alternate_reference_archive:
             args.verbose and start_msgs.append(("Alternate ref archive:", args.alternate_reference_archive))
@@ -874,8 +893,8 @@ def main():
         args.verbose and start_msgs.append(("PAR2 enabled:", config_settings.par2_enabled))
         args.verbose and start_msgs.append(("--do-not-compare:", args.do_not_compare))
 
-        dangerous_keywords = ["--do-not", "alternate"] # TODO: add more dangerous keywords
-        print_aligned_settings(start_msgs)
+        highlight_keywords = ["--do-not", "alternate"] # TODO: add more dangerous keywords
+        print_aligned_settings(start_msgs, quiet=not args.verbose, highlight_keywords=highlight_keywords)
 
         # sanity check
         if args.backup_definition and not os.path.exists(os.path.join(config_settings.backup_d_dir, args.backup_definition)):

dar_backup/dar_backup_systemd.py

@@ -1,3 +1,6 @@
+#!/usr/bin/env python3
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 from pathlib import Path
 import subprocess
 import argparse

dar_backup/demo.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python3
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 """
-installer.py source code is here: https://github.com/per2jensen/dar-backup/tree/main/v2/src/dar_backup/installer.py
+demo.py source code is here: https://github.com/per2jensen/dar-backup/tree/main/v2/src/dar_backup/demo.py
 This script is part of dar-backup, a backup solution for Linux using dar and systemd.
 
 Licensed under GNU GENERAL PUBLIC LICENSE v3, see the supplied file "LICENSE" for details.
@@ -10,7 +12,9 @@ not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 See section 15 and section 16 in the supplied "LICENSE" file
 
 This script can be used to configure dar-backup on your system.
-It is non-destructive and will not overwrite any existing files or directories.
+It is non-destructive and will not overwrite any existing files or directories under --override is used.
+
+User can set ROOT_DIR, DIR_TO_BACKUP and BACKUP_DIR (destination for backups) via optins to override defaults.
 """
 
 import argparse
@@ -19,120 +23,189 @@ import shutil
 import sys 
 
 from . import __about__ as about
+from . import util
+
+from jinja2 import Environment, FileSystemLoader
 from pathlib import Path
+from typing import Dict, Tuple
+
+
+CONFIG_DIR = util.normalize_dir(util.expand_path("~/.config/dar-backup"))
+DAR_BACKUP_DIR = util.normalize_dir(util.expand_path("~/dar-backup"))
+
 
-LICENSE = '''Licensed under GNU GENERAL PUBLIC LICENSE v3, see the supplied file "LICENSE" for details.
-THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW, not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-See section 15 and section 16 in the supplied "LICENSE" file.'''
 
-CONFIG_DIR = os.path.expanduser("~/.config/dar-backup")
-DAR_BACKUP_DIR = os.path.expanduser("~/dar-backup/")
+def check_directories(args, vars_map: Dict[str,str]) -> bool:
+    """
+    Check if the directories exist and create them if they don't.
 
-BACKUP_DEFINITION = '''
-# Demo of a `dar-backup` definition file
-# This back definition file configures a backup of ~/.config/dar-backup
-# `dar-backup` puts the backups in ~/dar-backup/backups
-# ------------------------------------------------------------------------
+    Returns:
+        bool: True if the directories were created successfully, False otherwise.
+    """
+    result = True
+    for key in ("DAR_BACKUP_DIR","BACKUP_DIR","TEST_RESTORE_DIR","CONFIG_DIR","BACKUP_D_DIR"):
+        path = Path(vars_map[key])
+        if path.exists() and not args.override:
+            print(f"Directory '{path}' already exists")
+            result = False
+    return result
 
-# Switch to ordered selection mode, which means that the following options
-# will be considered top to bottom
--am
 
-# Backup Root dir
--R @@HOME_DIR@@
+def generate_file(args, template: str, file_path: Path, vars_map: Dict[str, str], opts_dict: Dict[str, str]) -> bool:
+    """
+    Generate a file using a Jinja2 template.
 
-# Directories to backup below the Root dir
--g .config/dar-backup
+    Args:
+        args: Command line arguments.
+        template (str): The name of the template file.
+        file_path (Path): The path where the generated file will be saved.
+        vars_map (Dict[str, str]): A dictionary containing variables for the template.
+        opts_dict (Dict[str, str]): A dictionary containing options given by user.
 
-# Examples of directories to exclude below the Root dir
- -P mnt
- -P .private
- -P .cache   
+    Returns:
+        bool: True if the file was generated successfully, False otherwise.
+    """
+    current_script_dir = os.path.dirname(os.path.abspath(__file__))
+    env = Environment(loader=FileSystemLoader(current_script_dir))
+    tpl = env.get_template(template)
+    rendered = tpl.render(vars_map = vars_map, opts_dict = opts_dict)  
+    if rendered is None:
+        print(f"Error: Template '{template}' could not be rendered.")
+        return False    
+    if os.path.exists(file_path) and not args.override:
+        print(f"Error: File '{file_path}' already exists. Use --override to overwrite.")
+        return False
+    file_path.parent.mkdir(parents=True, exist_ok=True)
+    file_path.write_text(rendered)
+    print(f"File generated at '{file_path}'")
 
-# compression level
- -z5
 
- # no overwrite, if you rerun a backup, 'dar' halts and asks what to do
- -n
- 
- # size of each slice in the archive
- --slice 10G
 
-# bypass directores marked as cache directories
-# http://dar.linux.free.fr/doc/Features.html
---cache-directory-tagging
-'''
+def setup_dicts(args, vars_map: Dict[str, str]) -> Tuple[Dict[str, str], Dict[str, str]]:
+    """
+    Override various entries in the dictionaries for jinja templating with user input.
+
+    Returns:
+        Tuple[Dict[str, str], Dict[str, str]]: A tuple containing the vars_map and opts_dict dictionaries.
+    """
+    opts_dict = {}
+    if args.root_dir:
+        opts_dict["ROOT_DIR"] = args.root_dir
+    if args.dir_to_backup:
+        opts_dict["DIR_TO_BACKUP"] = args.dir_to_backup 
+    if args.backup_dir:
+        opts_dict["BACKUP_DIR"] = args.backup_dir
+
+    for key, value in opts_dict.items():
+        vars_map[key] = value
+
+    return vars_map, opts_dict
 
 
 def main():
     parser = argparse.ArgumentParser(
-        description="Set up `dar-backup` on your system.",
+        description="Set up demo configuration for `dar-backup` on your system.",
     )
     parser.add_argument(
         "-i", "--install",
         action="store_true",
-        help="Deploy a simple config file, use ~/dar-backup/ for log file, archives and restore tests."
+        help="Deploy demo config files and directories. Will not overwrite existing files or directories unless --override is used."
+    )
+    req = parser.add_argument_group(
+    'These options must be used together'
+    )
+    req.add_argument(
+        "--root-dir",
+        type=str,
+        help="Specify the root directory for the backup."
+    )
+    req.add_argument(
+        "--dir-to-backup",
+        type=str,
+        help="Directory to backup, relative to the root directory."
+    )
+    parser.add_argument(
+        "--backup-dir",
+        type=str,
+        help="Directory where backups and redundancy files are put"
+    )
+    parser.add_argument(
+        "--override",
+        action="store_true",
+        help="By default, the script will not overwrite existing files or directories. Use this option to override this behavior."
     )
     parser.add_argument(
         "-v", "--version",
         action="version",
-        version=f"%(prog)s version {about.__version__}, {LICENSE}"
+        version=f"%(prog)s version {about.__version__}, {about.__license__}"
+    )
+    parser.add_argument(
+        "-g", "--generate",
+        action="store_true",
+        help="Generate config files and put them in /tmp/."
     )
 
     args = parser.parse_args()
 
-    if args.install:
-        errors = []
-        if os.path.exists(CONFIG_DIR):
-            errors.append(f"Config directory '{CONFIG_DIR}' already exists.")
-        if os.path.exists(DAR_BACKUP_DIR):
-            errors.append(f"Directory '{DAR_BACKUP_DIR}' already exists.")
-
-        if errors:
-            for error in errors:
-                print(f"Error: {error}")
+    group = [args.root_dir, args.dir_to_backup]
+    if any(group) and not all(group):
+        parser.error(
+            "Options --root-dir, --dir-to-backup must all be specified together."
+        )
+        exit(1)
+
+    args.root_dir = util.normalize_dir(util.expand_path(args.root_dir)) if args.root_dir else None
+    args.backup_dir = util.normalize_dir(util.expand_path(args.backup_dir)) if args.backup_dir else None
+    args.dir_to_backup = util.normalize_dir(util.expand_path(args.dir_to_backup)) if args.dir_to_backup else None
+
+
+
+    vars_map = {
+    #  dar-backup.conf variables 
+        "CONFIG_DIR"       : CONFIG_DIR,
+        "DAR_BACKUP_DIR"   : DAR_BACKUP_DIR,
+        "BACKUP_DIR"       : os.path.join(DAR_BACKUP_DIR, "backups"),
+        "BACKUP_D_DIR"     : os.path.join(CONFIG_DIR, "backup.d"),
+        "TEST_RESTORE_DIR" : os.path.join(DAR_BACKUP_DIR, "restore"),
+    #  backup definition variables
+        "ROOT_DIR"         : util.normalize_dir(util.expand_path("$HOME")),
+        "DIR_TO_BACKUP"    : ".config/dar-backup",
+    } 
+
+
+    vars_map, opts_dict = setup_dicts(args, vars_map)
+
+    if args.generate:
+        print("Generating backup definition file...")
+        vars_map["DAR_BACKUP_DIR"] = "/tmp"
+        args.override = True
+        generate_file(args, "demo_backup_def.j2", Path("/tmp/dar-backup/backup.d/demo"), vars_map, opts_dict)
+        vars_map["CONFIG_DIR"] = "/tmp"
+        generate_file(args, "dar-backup.conf.j2", Path("/tmp/dar-backup.conf"), vars_map, opts_dict)
+    elif args.install:
+        if not check_directories(args, vars_map):
+            print("Error: One or more directories already exist.\nSpecify non-existent directories or use --override to overwrite.")
             sys.exit(1)
 
-        try:
-            os.makedirs(DAR_BACKUP_DIR, exist_ok=False)
-            os.makedirs(os.path.join(DAR_BACKUP_DIR, "backups"), exist_ok=False)
-            os.makedirs(os.path.join(DAR_BACKUP_DIR, "restore"), exist_ok=False)
-            os.makedirs(CONFIG_DIR, exist_ok=False)
-            os.makedirs(os.path.join(CONFIG_DIR, "backup.d"), exist_ok=False)
-            print(f"Directories created: `{DAR_BACKUP_DIR}` and `{CONFIG_DIR}`")
-
-            script_dir = Path(__file__).parent
-            source_file = script_dir / "dar-backup.conf"
-            destination_file = Path(CONFIG_DIR) / "dar-backup.conf"
-
-            try:
-                shutil.copy2(source_file, destination_file)
-                print(f"Config file deployed to {destination_file}")
-            except Exception as e:
-                print(f"Error: Could not copy config file: {e}")
-                sys.exit(1)
-
-
-            backup_definition = BACKUP_DEFINITION.replace("@@HOME_DIR@@", os.path.expanduser("~"))
-
-            try:
-                with open(os.path.join(CONFIG_DIR, "backup.d", "default"), "w") as f:
-                    f.write(backup_definition)
-                print(f"Default backup definition file deployed to {os.path.join(CONFIG_DIR, 'backup.d', 'default')}")
-            except Exception as e:
-                print(f"Error: Could not write default backup definition: {e}")
-                sys.exit(1)
-        except Exception as e:
-            print(f"Installation failed: {e}")
-            sys.exit(1)
+        Path(vars_map["DAR_BACKUP_DIR"]).mkdir(parents=True, exist_ok=True)
+        Path(vars_map["BACKUP_DIR"]).mkdir(parents=True, exist_ok=True)
+        Path(vars_map["TEST_RESTORE_DIR"]).mkdir(parents=True, exist_ok=True)
+        Path(vars_map["CONFIG_DIR"]).mkdir(parents=True, exist_ok=True)
+        Path(vars_map["BACKUP_D_DIR"]).mkdir(parents=True, exist_ok=True)
+        print(f"Directories created.")
+
+        generate_file(args, "demo_backup_def.j2", Path(vars_map["BACKUP_D_DIR"]).joinpath("demo"), vars_map, opts_dict)
+        generate_file(args, "dar-backup.conf.j2", Path(vars_map["CONFIG_DIR"]).joinpath("dar-backup.conf"), vars_map, opts_dict)
 
-        print("1. Now run `manager --create` to create the catalog database.")
+        print("1. Now run `manager --create-db` to create the catalog database.")
         print("2. Then you can run `dar-backup --full-backup` to create a backup.")
         print("3. List backups with `dar-backup --list`")
         print("4. List contents of a backup with `dar-backup --list-contents <backup-name>`")
+    else:
+        parser.print_help()
+        sys.exit(1) 
 
     sys.exit(0)
 
-
 if __name__ == "__main__":
     main()

dar_backup/demo_backup_def.j2

@@ -0,0 +1,62 @@
+
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# ------------------------------------------------------------------------
+# Demo of a `dar-backup` definition file
+# This file was generated by dar-backup's `demo` program.
+# 
+{%- if opts_dict | length > 0 %}
+# Options given to the `demo` program:
+{% endif %}
+{%- if opts_dict.ROOT_DIR -%}
+# --root-dir : {{ opts_dict.ROOT_DIR }}  
+{% endif %}
+{%- if opts_dict.DIR_TO_BACKUP -%}
+# --dir-to-backup : {{ opts_dict.DIR_TO_BACKUP }}  
+{% endif -%}
+{%- if opts_dict.BACKUP_DIR -%}
+# --backup-dir : {{ opts_dict.BACKUP_DIR }}
+{% endif %}
+#
+# Variables used to generate this file:
+# =====================================
+{% for k,v in vars_map|dictsort %}# {{ k }} : {{ v }}
+{% endfor -%}
+# ------------------------------------------------------------------------
+
+# Switch to ordered selection mode, which means that the following options
+# will be considered top to bottom
+-am
+
+# Backup Root dir
+{%- if vars_map.ROOT_DIR %}
+-R {{ vars_map.ROOT_DIR }}
+{% endif -%}
+
+{% if vars_map.DIR_TO_BACKUP %}
+# Directories to backup below the Root dir
+-g {{ vars_map.DIR_TO_BACKUP }}
+
+# This is an example of exclusion of a `.private` directory inside the
+# directory that is backed up
+-P {{ vars_map.DIR_TO_BACKUP }}/.private
+{%- else %}
+# Examples of directories to exclude below the Root dir
+-P mnt
+-P .cache
+{% endif %}
+
+# compression level
+-z5
+
+# no overwrite, if you rerun a backup, 'dar' halts and asks what to do
+# as `dar-backup` gives the `-Q` option to `dar`, the net effect of `-n` and `-Q` is
+# that `dar` will quit and not overwrite the existing backup 
+-n
+ 
+# size of each slice in the archive (10G is 10 Gigabytes)
+--slice 10G
+
+# bypass directores marked as cache directories
+# http://dar.linux.free.fr/doc/Features.html
+--cache-directory-tagging

dar_backup/exceptions.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 class ConfigSettingsError(Exception):
     """Raised when ConfigSettings encounters a critical error."""
     pass