✨ [+feature] Added mirror functionality (#1)

Author: davidbrownell

.github/workflows/standard.yaml

@@ -183,7 +183,7 @@ jobs:
     with:
       operating_system: ${{ matrix.os }}
       python_version: ${{ matrix.python_version }}
-      validation_command: FileBackup Version
+      validation_command: FileBackup version
 
 
 # ----------------------------------------------------------------------
@@ -239,4 +239,3 @@ jobs:
       PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
 
       MINISIGN_PRIVATE_KEY: ${{ secrets.MINISIGN_PRIVATE_KEY }}
-

.gitignore

@@ -12,3 +12,6 @@ Deactivate*.sh
 build/**
 dist/**
 src/FileBackup.egg-info/**
+
+minisign_key.pri
+minisign_key.pub

.python_project_bootstrapper_manifest.yml

@@ -7,7 +7,7 @@
 .github/release_sources.yaml: c2241d25423ec6e22afa41c6caed30162438af803e6de74ee466479ca6cd8246
 .github/workflows/codeql.yml: 5e6e94a06f17ebbd8d3042467327837bb2076c29a1414b794800a3c1b09cca7d
 .github/workflows/standard.yaml: 9b11066818a63fa28c19fae3b85f6737b8b805e40fd35635477af34ed40b93ea
-.gitignore: 37e0bff616592f003f1c993025a21e7f3a92c8f8f3bba8ffee8a8f9c2ce54365
+.gitignore: 4431dbdb4c35765df68c0084dd823a53749423267d3174b031f285df71049a87
 .python_project_bootstrapper_config.yml: 80ac560edbf136640da3cd66f0d0ea629ef052d095c6ebb26743a01c6559e0d5
 ActivateEpilog.py: 102bb407fb3efcdbb697c4c5ea0d98236d43490ff9297bfa00b37ffaed66501d
 Bootstrap.cmd: 48a673262f121c847d924d9b4b1db2a7ee01ef46d0aca8912d0c90f1f1d464c1

Build.py

@@ -54,7 +54,7 @@ def list_commands(self, *args, **kwargs):  # pylint: disable=unused-argument
     this_dir,
     package_dir.name,
     app,
-    default_min_coverage=90.0,
+    default_min_coverage=75.0,
 )
 
 UpdateVersion = RepoBuildTools.UpdateVersionFuncFactory(

pyproject.toml

@@ -43,7 +43,8 @@ classifiers = [
 ]
 
 dependencies = [
-    # TODO
+    "dbrownell_Common",
+    "paramiko ~= 3.4",
     "typer ~= 0.9"
 ]
 
@@ -70,7 +71,7 @@ Documentation = "https://github.com/davidbrownell/FileBackup"
 Repository = "https://github.com/davidbrownell/FileBackup"
 
 [project.scripts]
-FileBackup = "FileBackup:EntryPoint.app"
+FileBackup = "FileBackup.CommandLine:EntryPoint.app"
 
 # ----------------------------------------------------------------------
 # |
@@ -80,6 +81,16 @@ FileBackup = "FileBackup:EntryPoint.app"
 [tool.black]
 line-length = 100
 
+# ----------------------------------------------------------------------
+# |
+# |  coverage
+# |
+# ----------------------------------------------------------------------
+[tool.coverage.run]
+omit = [
+    "*/Impl/*",
+]
+
 # ----------------------------------------------------------------------
 # |
 # |  pylint

src/BuildBinary.py

@@ -33,7 +33,7 @@ def _GetVersionAndDocstring() -> tuple[str, str]:
 # ----------------------------------------------------------------------
 @cache
 def _GetEntryPoint() -> Path:
-    return PathEx.EnsureFile(Path(__file__).parent / _GetName() / "EntryPoint.py")
+    return PathEx.EnsureFile(Path(__file__).parent / _GetName() / "CommandLine" / "EntryPoint.py")
 
 
 # ----------------------------------------------------------------------

src/FileBackup/CommandLine/CommandLineArguments.py

@@ -0,0 +1,77 @@
+# ----------------------------------------------------------------------
+# |
+# |  CommandLineArguments.py
+# |
+# |  David Brownell <db@DavidBrownell.com>
+# |      2024-06-12 13:20:05
+# |
+# ----------------------------------------------------------------------
+# |
+# |  Copyright David Brownell 2024
+# |  Distributed under the MIT License.
+# |
+# ----------------------------------------------------------------------
+
+import re
+
+from typing import Pattern
+
+import typer
+
+
+# ----------------------------------------------------------------------
+def ToRegex(
+    values: list[str],
+) -> list[Pattern]:
+    expressions: list[Pattern] = []
+
+    for value in values:
+        try:
+            expressions.append(re.compile("^{}$".format(value)))
+        except re.error as ex:
+            raise typer.BadParameter(
+                "The regular expression '{}' is not valid ({}).".format(value, ex)
+            )
+
+    return expressions
+
+
+# ----------------------------------------------------------------------
+input_filename_or_dirs_argument = typer.Argument(
+    ..., exists=True, resolve_path=True, help="Input filename or directory."
+)
+
+ssd_option = typer.Option(
+    "--ssd",
+    help="Processes tasks in parallel to leverage the capabilities of solid-state-drives.",
+)
+ssd_option_default = False
+
+quiet_option = typer.Option("--quiet", help="Reduce the amount of information displayed.")
+quiet_option_default = False
+
+force_option = typer.Option(
+    "--force",
+    help="Ignore previous backup information and overwrite all data in the destination data store.",
+)
+force_option_default = False
+
+verbose_option = typer.Option("--verbose", help="Write verbose information to the terminal.")
+verbose_option_default = False
+
+debug_option = typer.Option("--debug", help="Write debug information to the terminal.")
+debug_option_default = False
+
+file_include_option = typer.Option(
+    "--file-include",
+    callback=ToRegex,
+    help="Regular expression (based on a posix path) used to include files and/or directories when preserving content.",
+)
+file_include_option_default: list[str] = []
+
+file_exclude_option = typer.Option(
+    "--file-exclude",
+    callback=ToRegex,
+    help="Regular expression (based on a posix path) used to exclude files and/or directories when preserving content.",
+)
+file_exclude_option_default: list[str] = []

src/FileBackup/EntryPoint.py src/FileBackup/CommandLine/EntryPoint.pysrc/FileBackup/EntryPoint.py renamed to src/FileBackup/CommandLine/EntryPoint.py

@@ -12,7 +12,8 @@
 
 from typer.core import TyperGroup  # type: ignore [import-untyped]
 
-from FileBackup import Math, __version__
+from FileBackup import __version__
+from FileBackup.CommandLine import MirrorEntryPoint
 
 
 # ----------------------------------------------------------------------
@@ -33,56 +34,12 @@ def list_commands(self, *args, **kwargs):  # pylint: disable=unused-argument
 )
 
 
-# ----------------------------------------------------------------------
-@app.command("Add")
-def Add(
-    x: int,
-    y: int,
-) -> None:
-    """Adds 2 values."""
-
-    sys.stdout.write(str(Math.Add(x, y)))
-
-
-# ----------------------------------------------------------------------
-@app.command("Sub")
-def Sub(
-    x: int,
-    y: int,
-) -> None:
-    """Subtracts 2 values."""
-
-    sys.stdout.write(str(Math.Sub(x, y)))
-
-
-# ----------------------------------------------------------------------
-@app.command("Mult")
-def Mult(
-    x: int,
-    y: int,
-) -> None:
-    """Multiplies 2 values."""
-
-    sys.stdout.write(str(Math.Mult(x, y)))
-
-
-# ----------------------------------------------------------------------
-@app.command("Div")
-def Div(
-    x: int,
-    y: int,
-) -> None:
-    """Divides 1 value by another."""
-
-    sys.stdout.write(str(Math.Div(x, y)))
+app.add_typer(MirrorEntryPoint.app, name="mirror", help=MirrorEntryPoint.__doc__)
 
 
-# ----------------------------------------------------------------------
-@app.command("Version")
-def Version() -> None:
-    """Prints the version of the package."""
-
-    sys.stdout.write(__version__)
+@app.command("version", no_args_is_help=False)
+def Version():
+    sys.stdout.write(f"FileBackup v{__version__}\n")
 
 
 # ----------------------------------------------------------------------