FileBackup 0.3.5__py3-none-any.whl → 0.4.0__py3-none-any.whl

FileBackup/DataStore/FastGlacierDataStore.py

@@ -70,10 +70,12 @@ class FastGlacierDataStore(BulkStorageDataStore):
                     )
                     return
 
-            with dm.Nested("Uploading to Fast Glacier...") as upload_dm:
-                command_line = f'glacier-con upload "{self.account_name}" "{local_path / "*"}" "{self.aws_region}" "{self._glacier_dir.as_posix()}"'
+                self._validated_command_line = True
 
-                upload_dm.WriteVerbose(f"Command Line: {command_line}\n\n")
+        with dm.Nested("Uploading to Fast Glacier...") as upload_dm:
+            command_line = f'glacier-con upload "{self.account_name}" "{local_path / "*"}" "{self.aws_region}" "{self._glacier_dir.as_posix()}"'
 
-                with upload_dm.YieldStream() as stream:
-                    upload_dm.result = SubprocessEx.Stream(command_line, stream)
+            upload_dm.WriteVerbose(f"Command Line: {command_line}\n\n")
+
+            with upload_dm.YieldStream() as stream:
+                upload_dm.result = SubprocessEx.Stream(command_line, stream)

FileBackup/DataStore/S3BrowserDataStore.py

@@ -0,0 +1,81 @@
+# ----------------------------------------------------------------------
+# |
+# |  S3BrowserDataStore.py
+# |
+# |  David Brownell <db@DavidBrownell.com>
+# |      2025-02-23 14:08:12
+# |
+# ----------------------------------------------------------------------
+# |
+# |  Copyright David Brownell 2025
+# |  Distributed under the MIT License.
+# |
+# ----------------------------------------------------------------------
+"""Contains the S3BrowserDataStore object"""
+
+from pathlib import Path
+from typing import Optional
+
+from dbrownell_Common.Streams.DoneManager import DoneManager  # type: ignore[import-untyped]
+from dbrownell_Common import SubprocessEx  # type: ignore[import-untyped]
+from dbrownell_Common.Types import override  # type: ignore[import-untyped]
+
+from FileBackup.DataStore.Interfaces.BulkStorageDataStore import BulkStorageDataStore
+
+
+# ----------------------------------------------------------------------
+class S3BrowserDataStore(BulkStorageDataStore):
+    """Data store that uses the S3 Browser application (https://s3browser.com/)"""
+
+    # ----------------------------------------------------------------------
+    def __init__(
+        self,
+        account_name: str,
+        bucket_name: str,
+        s3_dir: Optional[Path],
+    ) -> None:
+        super(S3BrowserDataStore, self).__init__()
+
+        self.account_name = account_name
+        self.bucket_name = bucket_name
+
+        self._s3_dir = self.bucket_name / (s3_dir or Path())
+
+        self._validated_command_line = False
+
+    # ----------------------------------------------------------------------
+    @override
+    def ExecuteInParallel(self) -> bool:
+        return False
+
+    # ----------------------------------------------------------------------
+    @override
+    def Upload(
+        self,
+        dm: DoneManager,
+        local_path: Path,
+    ) -> None:
+        if self._validated_command_line is False:
+            with dm.Nested(
+                "Validating S3 Browser on the command line...",
+                suffix="\n",
+            ) as check_dm:
+                result = SubprocessEx.Run("s3browser-cli license show")
+
+                check_dm.WriteVerbose(result.output)
+
+                if result.returncode != 0:
+                    check_dm.WriteError(
+                        "S3 Browser is not available; please make sure it exists in the path and run the script again.\n"
+                    )
+                    return
+
+                self._validated_command_line = True
+
+        with dm.Nested("Uploading via S3 Browser...") as upload_dm:
+            command_line = f's3browser-cli file upload "{self.account_name}" "{local_path / "*"}" "{self._s3_dir.as_posix()}"'
+
+            upload_dm.WriteVerbose(f"Command Line: {command_line}\n\n")
+
+            with upload_dm.YieldStream() as stream:
+                upload_dm.result = SubprocessEx.Stream(command_line, stream)

FileBackup/Impl/Common.py

@@ -22,7 +22,16 @@ from contextlib import contextmanager
 from dataclasses import dataclass, field
 from enum import auto, Enum
 from pathlib import Path
-from typing import Any, Callable, cast, Iterable, Iterator, Optional, Pattern, TYPE_CHECKING
+from typing import (
+    Any,
+    Callable,
+    cast,
+    Iterable,
+    Iterator,
+    Optional,
+    Pattern,
+    TYPE_CHECKING,
+)
 from urllib import parse as urlparse
 
 from dbrownell_Common import ExecuteTasks  # type: ignore[import-untyped]
@@ -35,6 +44,7 @@ from FileBackup.DataStore.FastGlacierDataStore import FastGlacierDataStore
 from FileBackup.DataStore.FileSystemDataStore import FileSystemDataStore
 from FileBackup.DataStore.Interfaces.DataStore import DataStore, ItemType
 from FileBackup.DataStore.Interfaces.FileBasedDataStore import FileBasedDataStore
+from FileBackup.DataStore.S3BrowserDataStore import S3BrowserDataStore
 from FileBackup.DataStore.SFTPDataStore import SFTPDataStore, SSH_PORT
 
 if TYPE_CHECKING:
@@ -79,6 +89,22 @@ FAST_GLACIER_TEMPLATE_REGEX = re.compile(
         [sep]                               )\/(?#
         Posix Working Dir                   )(?P<working_dir>.+)(?#
     Working Dir End                         ))?(?#
+    End                                     )$(?#
+    )""",
+)
+
+
+S3_BROWSER_TEMPLATE_REGEX = re.compile(
+    r"""(?#
+    Start                                   )^(?#
+    Prefix                                  )s3_browser:\/\/(?#
+    Account Name                            )(?P<account_name>[^@]+)(?#
+    [sep]                                   )@(?#
+    Bucket Name                             )(?P<bucket_name>[^\/]+)(?#
+    Working Dir Begin                       )(?:(?#
+        Posix Working Dir                   )(?P<working_dir>.+)(?#
+    Working Dir End                         ))?(?#
+    End                                     )$(?#
     )""",
 )
 
@@ -288,6 +314,17 @@ def GetDestinationHelp() -> str:
                 fast_glacier://MyFastGlacierAccount@us-west-2
                 fast_glacier://MyFastGlacierAccount@us-west-2/Glacier/Dir
 
+        S3 Browser
+        ----------
+        Write content using the S3 Browser application (https://s3browser.com/).
+
+            Format:
+                s3_browser://<s3_browser_account_name>@<bucket_name>[/<working_dir>]
+
+            Examples:
+                s3_browser://MyS3BrowserAccount@MyBucket
+                s3_browser://MyS3BrowserAccount@MyBucket/A/Working/Dir
+
         """,
     ).replace("\n", "\n\n")
 
@@ -337,6 +374,16 @@ def YieldDataStore(
             )
             return
 
+        # S3 Browser
+        s3_browser_match = S3_BROWSER_TEMPLATE_REGEX.match(destination)
+        if s3_browser_match:
+            yield S3BrowserDataStore(
+                s3_browser_match.group("account_name"),
+                s3_browser_match.group("bucket_name"),
+                Path(s3_browser_match.group("working_dir") or ""),
+            )
+            return
+
     # Create a FileSystemDataStore instance
     is_local_filesystem_override_value_for_testing: Optional[bool] = None
 

FileBackup/__init__.py

@@ -9,4 +9,4 @@
 # Note that this value will be overwritten by calls to `python ../../Build.py update_version` based
 # on changes observed in the git repository. The default value below will be used until the value
 # here is explicitly updated by the Continuous Integration system as part of a commit.
-__version__ = "0.3.5"
+__version__ = "0.4.0"

{FileBackup-0.3.5.dist-info → FileBackup-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: FileBackup
-Version: 0.3.5
+Version: 0.4.0
 Summary: Tool for creating and restoring file system backups.
 Author-email: David Brownell <github@DavidBrownell.com>
 License: MIT
@@ -28,15 +28,15 @@ Classifier: Topic :: System :: Systems Administration
 Classifier: Topic :: Utilities
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: dbrownell-Common
-Requires-Dist: paramiko ~=3.4
-Requires-Dist: typer ~=0.9
+Requires-Dist: dbrownell_Common
+Requires-Dist: paramiko~=3.4
+Requires-Dist: typer~=0.9
 Provides-Extra: dev
-Requires-Dist: dbrownell-DevTools ; extra == 'dev'
+Requires-Dist: dbrownell_DevTools; extra == "dev"
 Provides-Extra: package
-Requires-Dist: build ~=1.2 ; extra == 'package'
-Requires-Dist: cx-Freeze ~=6.15 ; extra == 'package'
-Requires-Dist: twine ~=5.1 ; extra == 'package'
+Requires-Dist: build~=1.2; extra == "package"
+Requires-Dist: cx_Freeze~=6.15; extra == "package"
+Requires-Dist: twine~=5.1; extra == "package"
 
 # FileBackup
 
@@ -57,9 +57,9 @@ TODO: Complete this section
 ## Additional Information
 Additional information can be found at these locations.
 
+<!-- [BEGIN] Additional Information -->
 | Title | Document | Description |
 | --- | --- | --- |
-<!-- [BEGIN] Additional Information -->
 | Code of Conduct | [CODE_OF_CONDUCT.md](https://github.com/davidbrownell/FileBackup/blob/main/CODE_OF_CONDUCT.md) | Information about the the norms, rules, and responsibilities we adhere to when participating in this open source community. |
 | Contributing | [CONTRIBUTING.md](https://github.com/davidbrownell/FileBackup/blob/main/CONTRIBUTING.md) | Information about contributing code changes to this project. |
 | Development | [DEVELOPMENT.md](https://github.com/davidbrownell/FileBackup/blob/main/DEVELOPMENT.md) | Information about development activities involved in making changes to this project. |

{FileBackup-0.3.5.dist-info → FileBackup-0.4.0.dist-info}/RECORD

@@ -1,25 +1,26 @@
 FileBackup/Mirror.py,sha256=FA9vfvPHOJzmN__Tx09ndWMeMTSWcED52BuVfeOBuKc,23904
 FileBackup/Offsite.py,sha256=2kK5ToJIHXIAPChtREcztp1e1L95ZJF6adIk-8d5V8g,62796
 FileBackup/Snapshot.py,sha256=r6l35Tl75WIQALtzN81r62XNkzJiTddzuihmlSb56Aw,27336
-FileBackup/__init__.py,sha256=PdLwrWcELNRlsgjQiRpRt_tOyJbhvspDa1_zkQ1G_V4,597
+FileBackup/__init__.py,sha256=HCvFRVx_mOm1khMXjjxM4UX5ljGM23mVGc5wKNrJRJY,597
 FileBackup/CommandLine/CommandLineArguments.py,sha256=79K4jVxtZ8xk1TfSJT8KIdkqZFjCEAspoIKP21GUXxE,2410
 FileBackup/CommandLine/EntryPoint.py,sha256=Fn62wtKV6uiTJ1dQpolNFUyWWeUOKKgetOFSXPgoe-w,1813
 FileBackup/CommandLine/MirrorEntryPoint.py,sha256=ZQ3mz0AgBwwn7n9uOuxN-lEQvm22u8SQbpWASkvRsAA,6800
 FileBackup/CommandLine/OffsiteEntryPoint.py,sha256=enbgeD_nhdR2T6UufySt33f4P2FnOVzsHiEktyVtLlo,12528
 FileBackup/CommandLine/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-FileBackup/DataStore/FastGlacierDataStore.py,sha256=YxmYY0IVZ6HTFE_2zMTz4g09Z9jJcXM9sMu_Yp86DAg,2982
+FileBackup/DataStore/FastGlacierDataStore.py,sha256=5J4W9FqB92hnHoRoZLo-DfMQ6uyjaOAWWrnuc0pvnJo,3017
 FileBackup/DataStore/FileSystemDataStore.py,sha256=XUvIQe2Yl-W6OPfvsJlPzDPsGclDOkKlozO0GJ-05bo,6791
+FileBackup/DataStore/S3BrowserDataStore.py,sha256=3NHl-advSbyXuL1kDu1wswbcAZbhmAGDu8yzlOuY5Us,2954
 FileBackup/DataStore/SFTPDataStore.py,sha256=TKz-hwwHg4avxKHDFRRz7FlKx3d40wT15ug1gCpu6VU,11374
 FileBackup/DataStore/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 FileBackup/DataStore/Interfaces/BulkStorageDataStore.py,sha256=qZo92nPDP_aVTxlohsc1ySnU9Skgxgo7Mj_tT0KxFZ8,1310
 FileBackup/DataStore/Interfaces/DataStore.py,sha256=FpQmxoqBS5indJYRxibkSXHTgk7U6HFyViI0BDqCcVw,1169
 FileBackup/DataStore/Interfaces/FileBasedDataStore.py,sha256=eMA_cQ-CED83z5uMDQZ18UFzBRvaXOwWz67kVu-2ftM,5307
 FileBackup/DataStore/Interfaces/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-FileBackup/Impl/Common.py,sha256=8XV0ARuLLci8AGjvW2lfJyXbA2FnyRpUHel4AI-7ReM,23712
+FileBackup/Impl/Common.py,sha256=L444spBwjUULSQcAGYV-90dHRFNgglC7k962NshpIJ8,25261
 FileBackup/Impl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-FileBackup-0.3.5.dist-info/LICENSE.txt,sha256=6ycKI8SWG920Saey4PGi5YUVLX0C_8hfqJr7Q0sqGI8,1071
-FileBackup-0.3.5.dist-info/METADATA,sha256=FJzSVtumCyGZ3rAxtBVwi4ZN_3T-7jg9Hd-qv-Z5_JA,3300
-FileBackup-0.3.5.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-FileBackup-0.3.5.dist-info/entry_points.txt,sha256=OlHrvdhWJQGIp4vCUJAqOWxW7y0ZH59qQ-2ImWFUcPI,69
-FileBackup-0.3.5.dist-info/top_level.txt,sha256=mXd2b6GEOpQCnmzgYEb6c_rfwlgP3RgmMuVDkQasxKw,11
-FileBackup-0.3.5.dist-info/RECORD,,
+FileBackup-0.4.0.dist-info/LICENSE.txt,sha256=6ycKI8SWG920Saey4PGi5YUVLX0C_8hfqJr7Q0sqGI8,1071
+FileBackup-0.4.0.dist-info/METADATA,sha256=QemMImLG2dvbvLt8t68rCA9YxYwWIdjtoL6cSTpkwo0,3291
+FileBackup-0.4.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+FileBackup-0.4.0.dist-info/entry_points.txt,sha256=OlHrvdhWJQGIp4vCUJAqOWxW7y0ZH59qQ-2ImWFUcPI,69
+FileBackup-0.4.0.dist-info/top_level.txt,sha256=mXd2b6GEOpQCnmzgYEb6c_rfwlgP3RgmMuVDkQasxKw,11
+FileBackup-0.4.0.dist-info/RECORD,,

{FileBackup-0.3.5.dist-info → FileBackup-0.4.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.2)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any