FileBackup 0.4.4__tar.gz → 0.5.2__tar.gz

{filebackup-0.4.4 → filebackup-0.5.2}/.copier-answers.yml

@@ -6,7 +6,7 @@
 # available at https://github.com/gt-sse-center/copier-UvScaffolding.
 #
 
-_commit: v0.2.0
+_commit: v0.2.4
 _src_path: .
 author_email: github@DavidBrownell.com
 author_name: David Brownell

{filebackup-0.4.4 → filebackup-0.5.2}/.github/workflows/CICD_impl.yml

@@ -66,6 +66,9 @@ jobs:
           python-version: ${{ matrix.python_version }}
           enable-cache: true
 
+      - name: Install Dependencies
+        run: uv sync --frozen
+
       - name: Run pre-commit scripts
         run: uv run pre-commit run --verbose
 
@@ -250,6 +253,9 @@ jobs:
           python-version: ${{ inputs.python_package_version }}
           enable-cache: true
 
+      - name: Install Dependencies
+        run: uv sync --frozen
+
       - name: Build Binary
         run: uv run python BuildBinary.py Build --verbose
 
@@ -261,6 +267,8 @@ jobs:
         with:
           name: Binary.${{ matrix.os }}
           path: FileBackup-${{ env.PACKAGE_VERSION }}.*
+
+  # ----------------------------------------------------------------------
   validate_binary:
     needs: [python_package, build_binary]
 

filebackup-0.5.2/.gitignore

@@ -0,0 +1,16 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.coverage
+.DS_Store
+.vscode
+coverage.xml
+minisign_key.pri
+post_generation_instructions.html

{filebackup-0.4.4 → filebackup-0.5.2}/BuildBinary.py

@@ -1,15 +1,21 @@
 import os
 import shutil
+import textwrap
+import uuid
 
 from pathlib import Path
 from typing import Annotated, Optional
 
 import typer
 
+from dbrownell_Common.ContextlibEx import ExitStack
 from dbrownell_Common import SubprocessEx
 from dbrownell_Common.Streams.DoneManager import DoneManager, Flags as DoneManagerFlags
+import inflect
 from typer.core import TyperGroup
 
+import FileBackup
+
 
 # ----------------------------------------------------------------------
 class NaturalOrderGrouper(TyperGroup):
@@ -46,12 +52,49 @@ def Build(
     with DoneManager.CreateCommandLine(
         flags=DoneManagerFlags.Create(verbose=verbose, debug=debug),
     ) as dm:
-        command_line = "cxfreeze --script src/FileBackup/CommandLine/EntryPoint.py --target-name=FileBackup"
-
-        dm.WriteVerbose(f"Command line: {command_line}\n\n")
-
-        with dm.YieldStream() as stream:
-            dm.result = SubprocessEx.Stream(command_line, stream)
+        # inflect uses the typeguard library, which relies on inspect to read the source code of
+        # inflect to enforce that arguments are the correct types when invoking functions. This
+        # works fine when running the application normally, but does not work by default with
+        # cx_Freeze because it does not include the source code of inflect in the built binary. This
+        # means that typeguard can't determine the types of the arguments, which causes it to raise
+        # an exception. The fix is to include the inflect source code in the built binary so that
+        # typeguard can find the function's types and not raise an exception.
+        inflect_filename = Path(inflect.__file__).relative_to(Path(__file__).parent)
+
+        configuration_filename = Path("setup{}.py".format(str(uuid.uuid4()).replace("-", "")))
+
+        configuration_filename.write_text(
+            textwrap.dedent(
+                f"""\
+                from cx_Freeze import setup, Executable
+
+                setup(
+                    name = "FileBackup",
+                    version = "{FileBackup.__version__}",
+                    options = {{
+                        "build_exe": {{
+                        "include_files": [
+                            (r"{inflect_filename}", "lib/inflect/{inflect_filename.name}"),
+                        ],
+                    "packages": []
+                        }},
+                    }},
+                    executables = [
+                        Executable(
+                            "src/FileBackup/CommandLine/EntryPoint.py",
+                            target_name="FileBackup",
+                            base=None,
+                        ),
+                    ],
+                )
+                """,
+            ),
+            encoding="utf-8",
+        )
+
+        with ExitStack(configuration_filename.unlink):
+            with dm.YieldStream() as stream:
+                dm.result = SubprocessEx.Stream(f'python "{configuration_filename}" build_exe', stream)
 
 
 # ----------------------------------------------------------------------

{filebackup-0.4.4 → filebackup-0.5.2}/DEVELOPMENT.md

@@ -19,7 +19,7 @@
 | Automated Testing | `uv run pytest` or<br/>`uv run pytest --no-cov` | Run automated tests using [pytest](https://docs.pytest.org/) and extract code coverage using [coverage](https://coverage.readthedocs.io/) based on settings in `pyproject.toml`. | :white_check_mark: | :white_check_mark: |
 | Semantic Version Generation | `uv run python -m AutoGitSemVer.scripts.UpdatePythonVersion ./src/FileBackup/__init__.py ./src` | Generate a new [Semantic Version](https://semver.org/) based on git commits using [AutoGitSemVer](https://github.com/davidbrownell/AutoGitSemVer). Version information is stored in `./src/FileBackup/__init__.py`. | | :white_check_mark: |
 | Python Package Creation | `uv build` | Create a python package using [uv](https://github.com/astral-sh/uv) based on settings in `pyproject.toml`. Generated packages will be written to `./dist`. | | :white_check_mark: |
-| Sign Artifacts | `uv run --with py-minisign python -c "import minisign; minisign.SecretKey.from_file(<temp_filename>).sign_file(<filename>, trusted_comment='<package_name> v<package_version>', drop_signature=True)` | Signs artifacts using [py-minisign](https://github.com/x13a/py-minisign). Note that the private key is stored as a [GitHub secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions). | | :white_check_mark: |
+| Sign Artifacts | `uv run python -c "import minisign; minisign.SecretKey.from_file(<temp_filename>).sign_file(<filename>, trusted_comment='<package_name> v<package_version>', drop_signature=True)` | Signs artifacts using [py-minisign](https://github.com/x13a/py-minisign). Note that the private key is stored as a [GitHub secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions). | | :white_check_mark: |
 | Python Package Publishing | `uv publish` | Publish a python package to [PyPi](https://pypi.org/) using [uv](https://github.com/astral-sh/uv) based on settings in `pyproject.toml`. | | :white_check_mark: |
 
 ## Contributing Changes

{filebackup-0.4.4 → filebackup-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FileBackup
-Version: 0.4.4
+Version: 0.5.2
 Summary: Tool for creating and restoring file system backups.
 Project-URL: Homepage, https://github.com/davidbrownell/FileBackup
 Project-URL: Documentation, https://github.com/davidbrownell/FileBackup
@@ -28,7 +28,7 @@ Classifier: Topic :: System :: Archiving :: Mirroring
 Classifier: Topic :: System :: Systems Administration
 Classifier: Topic :: Utilities
 Requires-Python: >=3.10
-Requires-Dist: dbrownell-common>=0.14.6
+Requires-Dist: dbrownell-common>=0.15.0
 Requires-Dist: paramiko>=3.5.1
 Requires-Dist: typer>=0.15.3
 Description-Content-Type: text/markdown
@@ -59,7 +59,7 @@ Description-Content-Type: text/markdown
 ## Overview
 TODO: Complete this section
 
-### How to use FileBackup
+### How to use `FileBackup`
 TODO: Complete this section
 
 <!-- Content below this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
@@ -72,11 +72,13 @@ TODO: Complete this section
 | Via [pip](https://pip.pypa.io/en/stable/) | `pip install FileBackup` |
 
 ### Verifying Signed Artifacts
-Artifacts are signed and validated using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
+Artifacts are signed and verified using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
 
 To verify that an artifact is valid, visit [the latest release](https://github.com/davidbrownell/FileBackup/releases/latest) and download the `.minisign` signature file that corresponds to the artifact, then run the following command, replacing `<filename>` with the name of the artifact to be verified:
 
-`uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>')"`
+```shell
+uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>'); print('The file has been verified.')"
+```
 
 ## Development
 Please visit [Contributing](https://github.com/davidbrownell/FileBackup/blob/main/CONTRIBUTING.md) and [Development](https://github.com/davidbrownell/FileBackup/blob/main/DEVELOPMENT.md) for information on contributing to this project.
@@ -94,4 +96,4 @@ Additional information can be found at these locations.
 | Security | [SECURITY.md](https://github.com/davidbrownell/FileBackup/blob/main/SECURITY.md) | Information about how to privately report security issues associated with this project. |
 
 ## License
-FileBackup is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.
+`FileBackup` is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.

{filebackup-0.4.4 → filebackup-0.5.2}/README.md

@@ -24,7 +24,7 @@
 ## Overview
 TODO: Complete this section
 
-### How to use FileBackup
+### How to use `FileBackup`
 TODO: Complete this section
 
 <!-- Content below this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
@@ -37,11 +37,13 @@ TODO: Complete this section
 | Via [pip](https://pip.pypa.io/en/stable/) | `pip install FileBackup` |
 
 ### Verifying Signed Artifacts
-Artifacts are signed and validated using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
+Artifacts are signed and verified using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
 
 To verify that an artifact is valid, visit [the latest release](https://github.com/davidbrownell/FileBackup/releases/latest) and download the `.minisign` signature file that corresponds to the artifact, then run the following command, replacing `<filename>` with the name of the artifact to be verified:
 
-`uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>')"`
+```shell
+uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>'); print('The file has been verified.')"
+```
 
 ## Development
 Please visit [Contributing](https://github.com/davidbrownell/FileBackup/blob/main/CONTRIBUTING.md) and [Development](https://github.com/davidbrownell/FileBackup/blob/main/DEVELOPMENT.md) for information on contributing to this project.
@@ -59,4 +61,4 @@ Additional information can be found at these locations.
 | Security | [SECURITY.md](https://github.com/davidbrownell/FileBackup/blob/main/SECURITY.md) | Information about how to privately report security issues associated with this project. |
 
 ## License
-FileBackup is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.
+`FileBackup` is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.

{filebackup-0.4.4 → filebackup-0.5.2}/pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 ]
 requires-python = ">= 3.10"
 dependencies = [
-    "dbrownell-common>=0.14.6",
+    "dbrownell-common>=0.15.0",
     "paramiko>=3.5.1",
     "typer>=0.15.3",
 ]
@@ -23,7 +23,7 @@ keywords = [
 license = "MIT"
 
 classifiers = [
-    "Development Status :: 4 - Beta",  # TODO
+    "Development Status :: 4 - Beta",
     "Environment :: Console",
     "Intended Audience :: Developers",
     "Intended Audience :: End Users/Desktop",
@@ -58,20 +58,21 @@ build-backend = "hatchling.build"
 
 [dependency-groups]
 dev = [
-    "autogitsemver>=0.8.0",
+    "autogitsemver>=0.8.4",
     "cx-freeze>=8.3.0",
-    "dbrownell-commitemojis>=0.1.3",
+    "dbrownell-commitemojis>=0.1.4",
     "pre-commit>=4.2.0",
-    "pytest>=8.3.5",
-    "pytest-cov>=6.1.1",
-    "ruff>=0.11.8",
+    "py-minisign>=0.12.0",
+    "pytest>=8.4.1",
+    "pytest-cov>=6.2.1",
+    "ruff>=0.12.3",
 ]
 
 [tool.hatch.version]
 path = "src/FileBackup/__init__.py"
 
 [tool.pytest.ini_options]
-addopts = "--verbose -vv --capture=no --cov=FileBackup --cov-fail-under=85.0"
+addopts = "--verbose -vv --capture=no --cov=FileBackup --cov-report term --cov-report xml:coverage.xml --cov-fail-under=85.0"
 python_files = [
     "**/*Test.py",
 ]
@@ -87,12 +88,21 @@ ignore = [
     "ANN003", # Missing type annotation for `**kwargs`
     "BLE001", # Do not catch blind exception: `Exception`
     "COM812", # Trailing comma missing
+    "D105", # Missing docstring in magic method
+    "D107", # Missing docstring in `__init__` method
     "D202", # No blank lines allowed after function docstring
     "E501", # Line too long
+    "FIX002", # Line contains TODO, consider resolving the issue
     "I001", # Import block is un-sorted or un-formatted
     "N802", # Function name `xxx` should be lowercase
     "N999", # Invalid module name
+    "RSE102", # Unnecessary parentheses on raise exception
     "S101", # Use of assert detected
+    "TC006", # Add quotes to type expression in `typing.cast()`
+    "TD002", # Missing author in TODO
+    "TD003", # Missing issue link for this TODO
+    "TRY002", # Create your own exception
+    "TRY300", # Consider moving this statement to an `else` block
     "UP032", # Use f-string instead of `format` call
 ]
 

{filebackup-0.4.4 → filebackup-0.5.2}/src/FileBackup/CommandLine/OffsiteEntryPoint.py

@@ -241,6 +241,12 @@ def Restore(  # pylint: disable=dangerous-default-value
             help="Working directory to use when decompressing archives; provide this value during a dry run and subsequent execution to only download and extract the backup content once.",
         ),
     ] = None,
+    continue_on_errors: Annotated[
+        bool,
+        typer.Option(
+            "--continue-on-errors", help="Continue restoring files even if some files cannot be restored."
+        ),
+    ] = False,
 ) -> None:
     """Restores content from an offsite data store."""
 
@@ -263,6 +269,7 @@ def Restore(  # pylint: disable=dangerous-default-value
                 quiet=quiet,
                 dry_run=dry_run,
                 overwrite=overwrite,
+                continue_on_errors=continue_on_errors,
             )