rclone-api 1.0.45__py2.py3-none-any.whl → 1.0.47__py2.py3-none-any.whl

rclone_api/completed_process.py

@@ -19,3 +19,31 @@ class CompletedProcess:
 
     def successes(self) -> list[subprocess.CompletedProcess]:
         return [p for p in self.completed if p.returncode == 0]
+
+    @property
+    def stdout(self) -> str:
+        tmp: list[str] = []
+        for cp in self.completed:
+            stdout = cp.stdout
+            if stdout is not None:
+                tmp.append(stdout)
+        return "\n".join(tmp)
+
+    @property
+    def stderr(self) -> str:
+        tmp: list[str] = []
+        for cp in self.completed:
+            stderr = cp.stderr
+            if stderr is not None:
+                tmp.append(stderr)
+        return "\n".join(tmp)
+
+    @property
+    def returncode(self) -> int | None:
+        for cp in self.completed:
+            rtn = cp.returncode
+            if rtn is None:
+                return None
+            if rtn != 0:
+                return rtn
+        return 0

rclone_api/exec.py

@@ -13,11 +13,15 @@ class RcloneExec:
     rclone_config: Path | Config
     rclone_exe: Path
 
-    def execute(self, cmd: list[str], check: bool) -> subprocess.CompletedProcess:
+    def execute(
+        self, cmd: list[str], check: bool, capture: bool | None = None
+    ) -> subprocess.CompletedProcess:
         """Execute rclone command."""
         from rclone_api.util import rclone_execute
 
-        return rclone_execute(cmd, self.rclone_config, self.rclone_exe, check=check)
+        return rclone_execute(
+            cmd, self.rclone_config, self.rclone_exe, check=check, capture=capture
+        )
 
     def launch_process(self, cmd: list[str], capture: bool | None) -> Process:
         """Launch rclone process."""

rclone_api/rclone.py

@@ -57,12 +57,62 @@ class Rclone:
                 raise ValueError(f"Rclone config file not found: {rclone_conf}")
         self._exec = RcloneExec(rclone_conf, get_rclone_exe(rclone_exe))
 
-    def _run(self, cmd: list[str], check: bool = True) -> subprocess.CompletedProcess:
-        return self._exec.execute(cmd, check=check)
+    def _run(
+        self, cmd: list[str], check: bool = True, capture: bool | None = None
+    ) -> subprocess.CompletedProcess:
+        return self._exec.execute(cmd, check=check, capture=capture)
 
     def _launch_process(self, cmd: list[str], capture: bool | None = None) -> Process:
         return self._exec.launch_process(cmd, capture=capture)
 
+    def webgui(self, other_args: list[str] | None = None) -> Process:
+        """Launch the Rclone web GUI."""
+        cmd = ["rcd", "--rc-web-gui"]
+        if other_args:
+            cmd += other_args
+        return self._launch_process(cmd, capture=False)
+
+    def launch_server(
+        self,
+        addr: str | None = None,
+        user: str | None = None,
+        password: str | None = None,
+        other_args: list[str] | None = None,
+    ) -> Process:
+        """Launch the Rclone server so it can receive commands"""
+        cmd = ["rcd"]
+        if addr is not None:
+            cmd += ["--rc-addr", addr]
+        if user is not None:
+            cmd += ["--rc-user", user]
+        if password is not None:
+            cmd += ["--rc-pass", password]
+        if other_args:
+            cmd += other_args
+        out = self._launch_process(cmd, capture=False)
+        time.sleep(1)  # Give it some time to launch
+        return out
+
+    def remote_control(
+        self,
+        addr: str,
+        user: str | None = None,
+        password: str | None = None,
+        capture: bool | None = None,
+        other_args: list[str] | None = None,
+    ) -> CompletedProcess:
+        cmd = ["rc"]
+        if addr:
+            cmd += ["--rc-addr", addr]
+        if user is not None:
+            cmd += ["--rc-user", user]
+        if password is not None:
+            cmd += ["--rc-pass", password]
+        if other_args:
+            cmd += other_args
+        cp = self._run(cmd, capture=capture)
+        return CompletedProcess.from_subprocess(cp)
+
     def obscure(self, password: str) -> str:
         """Obscure a password for use in rclone config files."""
         cmd_list: list[str] = ["obscure", password]
@@ -185,10 +235,14 @@ class Rclone:
 
         yield from walk(dir_obj, max_depth=max_depth, breadth_first=breadth_first)
 
-    def cleanup(self, path: str) -> CompletedProcess:
+    def cleanup(
+        self, path: str, other_args: list[str] | None = None
+    ) -> CompletedProcess:
         """Cleanup any resources used by the Rclone instance."""
         # rclone cleanup remote:path [flags]
         cmd = ["cleanup", path]
+        if other_args:
+            cmd += other_args
         out = self._run(cmd)
         return CompletedProcess.from_subprocess(out)
 
@@ -246,7 +300,7 @@ class Rclone:
 
                     # print(include_files_txt)
                     cmd_list: list[str] = [
-                        "delete",
+                        "copy",
                         remote,
                         "--files-from",
                         str(include_files_txt),

rclone_api/util.py

@@ -78,10 +78,12 @@ def rclone_execute(
     rclone_conf: Path | Config,
     rclone_exe: Path,
     check: bool,
+    capture: bool | None = None,
     verbose: bool | None = None,
 ) -> subprocess.CompletedProcess:
     tempdir: TemporaryDirectory | None = None
     verbose = get_verbose(verbose)
+    capture = capture if isinstance(capture, bool) else True
     assert verbose is not None
 
     try:
@@ -97,7 +99,7 @@ def rclone_execute(
             cmd_str = subprocess.list2cmdline(cmd)
             print(f"Running: {cmd_str}")
         cp = subprocess.run(
-            cmd, capture_output=True, encoding="utf-8", check=False, shell=False
+            cmd, capture_output=capture, encoding="utf-8", check=False, shell=False
         )
         if cp.returncode != 0:
             cmd_str = subprocess.list2cmdline(cmd)

{rclone_api-1.0.45.dist-info → rclone_api-1.0.47.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.0.45
+Version: 1.0.47
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 Maintainer: Zachary Vorhies

{rclone_api-1.0.45.dist-info → rclone_api-1.0.47.dist-info}/RECORD

@@ -1,27 +1,27 @@
 rclone_api/__init__.py,sha256=fvWhio7i71rS5JtIr3l-36F6LRHo0ddpq0VX-6P5ldY,495
 rclone_api/cli.py,sha256=dibfAZIh0kXWsBbfp3onKLjyZXo54mTzDjUdzJlDlWo,231
-rclone_api/completed_process.py,sha256=s0flUibhTWU2d-KgVnZ62VGFS3HlICJrtPr8YJCdk3A,651
+rclone_api/completed_process.py,sha256=Pp-hXnLgej0IGO5ee9Fmx64dGzIofbQFEUyXdFCvO54,1371
 rclone_api/config.py,sha256=tP6cU9DnCCEIRc_KP9HPur1jFLLg2QGFSxNwFm6_MVw,118
 rclone_api/convert.py,sha256=Mx9Qo7zhkOedJd8LdhPvNGHp8znJzOk4f_2KWnoGc78,1012
 rclone_api/deprecated.py,sha256=qWKpnZdYcBK7YQZKuVoWWXDwi-uqiAtbjgPcci_efow,590
 rclone_api/diff.py,sha256=ELUQD1Mv8qaoAav13sEE-iKynFph70rQHj7-a4Z1pyo,4137
 rclone_api/dir.py,sha256=vV-bcI2ESijmwF5rPID5WO2K7soAfZa35wv4KRh_GIo,2154
 rclone_api/dir_listing.py,sha256=9Qqf2SUswrOEkyqmaH23V51I18X6ePiXb9B1vUwRF5o,1571
-rclone_api/exec.py,sha256=HWmnU2Jwb-3EttSbAJSaLloYA7YI2mHTzRJ5VEri9aM,941
+rclone_api/exec.py,sha256=1ovvaMXDEfLiT7BrYZyE85u_yFhEUwUNW3jPOzqknR8,1023
 rclone_api/file.py,sha256=D02iHJW1LhfOiM_R_yPHP8_ApnDiYrkuraVcrV8-qkw,1246
 rclone_api/filelist.py,sha256=xbiusvNgaB_b_kQOZoHMJJxn6TWGtPrWd2J042BI28o,767
 rclone_api/group_files.py,sha256=HxrRUi_kFlMblrCMFyv6rO56tVMEzgU4-vVeB_2-lbc,4606
 rclone_api/process.py,sha256=RrMfTe0bndmJ6gBK67ioqNvCstJ8aTC8RlGX1XBLlcw,4191
-rclone_api/rclone.py,sha256=D6621GGXotWym2lhpHIYzeQTnjC7j7wb4G-Mo7wbc6o,21513
+rclone_api/rclone.py,sha256=-F7tFWIOcBovdiaMgYpuTExjaY6rmI_Xo1rORXfP-h8,23280
 rclone_api/remote.py,sha256=c9hlRKBCg1BFB9MCINaQIoCg10qyAkeqiS4brl8ce-8,343
 rclone_api/rpath.py,sha256=8ZA_1wxWtskwcy0I8V2VbjKDmzPkiWd8Q2JQSvh-sYE,2586
-rclone_api/util.py,sha256=sUjH5NmsawmNbPMY7V6hD8vFJXCwbl44XM1kuij3tA0,3918
+rclone_api/util.py,sha256=IWNOOcPE0xdKvehzXQ9okIppGDBYWJPIfdbUME8BFVM,4015
 rclone_api/walk.py,sha256=kca0t1GAnF6FLclN01G8NG__Qe-ggodLtAbQSHyVPng,2968
 rclone_api/assets/example.txt,sha256=lTBovRjiz0_TgtAtbA1C5hNi2ffbqnNPqkKg6UiKCT8,54
 rclone_api/cmd/list_files.py,sha256=x8FHODEilwKqwdiU1jdkeJbLwOqUkUQuDWPo2u_zpf0,741
-rclone_api-1.0.45.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
-rclone_api-1.0.45.dist-info/METADATA,sha256=iikXSVPLGhKBfcKk5T63xDM6y4Fz0-EP98MiLOxVR10,4489
-rclone_api-1.0.45.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
-rclone_api-1.0.45.dist-info/entry_points.txt,sha256=XUoTX3m7CWxdj2VAKhEuO0NMOfX2qf-OcEDFwdyk9ZE,72
-rclone_api-1.0.45.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
-rclone_api-1.0.45.dist-info/RECORD,,
+rclone_api-1.0.47.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
+rclone_api-1.0.47.dist-info/METADATA,sha256=tEWwiE6PzwzCM50jJIAegd5dWbca2QFVhDUoDSRpxwc,4489
+rclone_api-1.0.47.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
+rclone_api-1.0.47.dist-info/entry_points.txt,sha256=XUoTX3m7CWxdj2VAKhEuO0NMOfX2qf-OcEDFwdyk9ZE,72
+rclone_api-1.0.47.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
+rclone_api-1.0.47.dist-info/RECORD,,