rclone-api 1.0.11__py2.py3-none-any.whl → 1.0.13__py2.py3-none-any.whl

rclone_api/dir.py

@@ -3,12 +3,15 @@ from typing import Generator
 from rclone_api.dir_listing import DirListing
 from rclone_api.remote import Remote
 from rclone_api.rpath import RPath
-from rclone_api.walk import walk
 
 
 class Dir:
     """Remote file dataclass."""
 
+    @property
+    def remote(self) -> Remote:
+        return self.path.remote
+
     def __init__(self, path: RPath | Remote) -> None:
         """Initialize Dir with either an RPath or Remote.
 
@@ -18,6 +21,7 @@ class Dir:
         if isinstance(path, Remote):
             # Need to create an RPath for the Remote's root
             self.path = RPath(
+                remote=path,
                 path=str(path),
                 name=str(path),
                 size=0,
@@ -33,10 +37,13 @@ class Dir:
     def ls(self, max_depth: int = 0) -> DirListing:
         """List files and directories in the given path."""
         assert self.path.rclone is not None
-        return self.path.rclone.ls(self.path.path, max_depth=max_depth)
+        dir = Dir(self.path)
+        return self.path.rclone.ls(dir, max_depth=max_depth)
 
     def walk(self, max_depth: int = -1) -> Generator[DirListing, None, None]:
         """List files and directories in the given path."""
+        from rclone_api.walk import walk
+
         assert self.path.rclone is not None
         return walk(self, max_depth=max_depth)
 

rclone_api/file.py

@@ -1,5 +1,3 @@
-import json
-
 from rclone_api.rpath import RPath
 
 
@@ -31,5 +29,4 @@ class File:
         return result.stdout
 
     def __str__(self) -> str:
-        out = self.path.to_json()
-        return json.dumps(out)
+        return str(self.path)

rclone_api/rclone.py

@@ -1,90 +1,97 @@
-"""
-Unit test file.
-"""
-
-import subprocess
-from pathlib import Path
-from typing import Generator
-
-from rclone_api import Dir
-from rclone_api.dir_listing import DirListing
-from rclone_api.remote import Remote
-from rclone_api.rpath import RPath
-from rclone_api.types import Config, RcloneExec
-from rclone_api.util import get_rclone_exe
-from rclone_api.walk import walk
-
-
-class Rclone:
-    def __init__(
-        self, rclone_conf: Path | Config, rclone_exe: Path | None = None
-    ) -> None:
-        if isinstance(rclone_conf, Path):
-            if not rclone_conf.exists():
-                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]) -> subprocess.CompletedProcess:
-        return self._exec.execute(cmd)
-
-    def ls(self, path: str | Remote, max_depth: int = 0) -> DirListing:
-        """List files in the given path.
-
-        Args:
-            path: Remote path or Remote object to list
-            max_depth: Maximum recursion depth (0 means no recursion)
-
-        Returns:
-            List of File objects found at the path
-        """
-        cmd = ["lsjson"]
-        if max_depth > 0:
-            cmd.extend(["--recursive", "--max-depth", str(max_depth)])
-        cmd.append(str(path))
-
-        cp = self._run(cmd)
-        text = cp.stdout
-        paths: list[RPath] = RPath.from_json_str(text)
-        for o in paths:
-            o.set_rclone(self)
-        return DirListing(paths)
-
-    def listremotes(self) -> list[Remote]:
-        cmd = ["listremotes"]
-        cp = self._run(cmd)
-        text: str = cp.stdout
-        tmp = text.splitlines()
-        tmp = [t.strip() for t in tmp]
-        # strip out ":" from the end
-        tmp = [t.replace(":", "") for t in tmp]
-        out = [Remote(name=t, rclone=self) for t in tmp]
-        return out
-
-    def walk(
-        self, path: str | Remote, max_depth: int = -1
-    ) -> Generator[DirListing, None, None]:
-        """Walk through the given path recursively.
-
-        Args:
-            path: Remote path or Remote object to walk through
-            max_depth: Maximum depth to traverse (-1 for unlimited)
-
-        Yields:
-            DirListing: Directory listing for each directory encountered
-        """
-        if isinstance(path, str):
-            # Create a Remote object for the path
-            rpath = RPath(
-                path=path,
-                name=path,
-                size=0,
-                mime_type="inode/directory",
-                mod_time="",
-                is_dir=True,
-            )
-            rpath.set_rclone(self)
-            dir_obj = Dir(rpath)
-        else:
-            dir_obj = Dir(path)
-
-        yield from walk(dir_obj, max_depth=max_depth)
+"""
+Unit test file.
+"""
+
+import subprocess
+from pathlib import Path
+from typing import Generator
+
+from rclone_api import Dir
+from rclone_api.dir_listing import DirListing
+from rclone_api.remote import Remote
+from rclone_api.rpath import RPath
+from rclone_api.types import Config, RcloneExec
+from rclone_api.util import get_rclone_exe
+from rclone_api.walk import walk
+
+
+class Rclone:
+    def __init__(
+        self, rclone_conf: Path | Config, rclone_exe: Path | None = None
+    ) -> None:
+        if isinstance(rclone_conf, Path):
+            if not rclone_conf.exists():
+                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]) -> subprocess.CompletedProcess:
+        return self._exec.execute(cmd)
+
+    def ls(self, path: Dir | Remote | str, max_depth: int | None = None) -> DirListing:
+        """List files in the given path.
+
+        Args:
+            path: Remote path or Remote object to list
+            max_depth: Maximum recursion depth (0 means no recursion)
+
+        Returns:
+            List of File objects found at the path
+        """
+        cmd = ["lsjson"]
+        if max_depth is not None:
+            cmd.append("--recursive")
+            if max_depth > -1:
+                cmd.append("--max-depth")
+                cmd.append(str(max_depth))
+        cmd.append(str(path))
+        remote = path.remote if isinstance(path, Dir) else path
+        assert isinstance(remote, Remote)
+
+        cp = self._run(cmd)
+        text = cp.stdout
+        paths: list[RPath] = RPath.from_json_str(text, remote)
+        for o in paths:
+            o.set_rclone(self)
+        return DirListing(paths)
+
+    def listremotes(self) -> list[Remote]:
+        cmd = ["listremotes"]
+        cp = self._run(cmd)
+        text: str = cp.stdout
+        tmp = text.splitlines()
+        tmp = [t.strip() for t in tmp]
+        # strip out ":" from the end
+        tmp = [t.replace(":", "") for t in tmp]
+        out = [Remote(name=t, rclone=self) for t in tmp]
+        return out
+
+    def walk(
+        self, path: Dir | Remote, max_depth: int = -1
+    ) -> Generator[DirListing, None, None]:
+        """Walk through the given path recursively.
+
+        Args:
+            path: Remote path or Remote object to walk through
+            max_depth: Maximum depth to traverse (-1 for unlimited)
+
+        Yields:
+            DirListing: Directory listing for each directory encountered
+        """
+        if isinstance(path, Dir):
+            # Create a Remote object for the path
+            remote = path.remote
+            rpath = RPath(
+                remote=remote,
+                path=path.path.path,
+                name=path.path.name,
+                size=0,
+                mime_type="inode/directory",
+                mod_time="",
+                is_dir=True,
+            )
+            rpath.set_rclone(self)
+            dir_obj = Dir(rpath)
+        else:
+            dir_obj = Dir(path)
+
+        yield from walk(dir_obj, max_depth=max_depth)

rclone_api/rpath.py

@@ -1,12 +1,15 @@
 import json
 from typing import Any
 
+from rclone_api.remote import Remote
+
 
 class RPath:
     """Remote file dataclass."""
 
     def __init__(
         self,
+        remote: Remote,
         path: str,
         name: str,
         size: int,
@@ -16,6 +19,10 @@ class RPath:
     ) -> None:
         from rclone_api.rclone import Rclone
 
+        if "dst:" in path:
+            raise ValueError(f"Invalid path: {path}")
+
+        self.remote = remote
         self.path = path
         self.name = name
         self.size = size
@@ -32,9 +39,10 @@ class RPath:
         self.rclone = rclone
 
     @staticmethod
-    def from_dict(data: dict) -> "RPath":
+    def from_dict(data: dict, remote: Remote) -> "RPath":
         """Create a File from a dictionary."""
         return RPath(
+            remote,
             data["Path"],
             data["Name"],
             data["Size"],
@@ -45,21 +53,21 @@ class RPath:
         )
 
     @staticmethod
-    def from_array(data: list[dict]) -> list["RPath"]:
+    def from_array(data: list[dict], remote: Remote) -> list["RPath"]:
         """Create a File from a dictionary."""
         out: list[RPath] = []
         for d in data:
-            file: RPath = RPath.from_dict(d)
+            file: RPath = RPath.from_dict(d, remote)
             out.append(file)
         return out
 
     @staticmethod
-    def from_json_str(json_str: str) -> list["RPath"]:
+    def from_json_str(json_str: str, remote: Remote) -> list["RPath"]:
         """Create a File from a JSON string."""
         json_obj = json.loads(json_str)
         if isinstance(json_obj, dict):
-            return [RPath.from_dict(json_obj)]
-        return RPath.from_array(json_obj)
+            return [RPath.from_dict(json_obj, remote)]
+        return RPath.from_array(json_obj, remote)
 
     def to_json(self) -> dict:
         return {
@@ -73,5 +81,4 @@ class RPath:
         }
 
     def __str__(self) -> str:
-        out = self.to_json()
-        return json.dumps(out)
+        return f"{self.remote.name}:{self.path}"

rclone_api/util.py

@@ -1,10 +1,61 @@
+import os
 import shutil
 import subprocess
 from pathlib import Path
 from tempfile import TemporaryDirectory
+from typing import Any
 
+from rclone_api.dir import Dir
+from rclone_api.remote import Remote
+from rclone_api.rpath import RPath
 from rclone_api.types import Config
 
+# from .rclone import Rclone
+
+
+def to_path(item: Dir | Remote | str, rclone: Any) -> RPath:
+    from rclone_api.rclone import Rclone
+
+    assert isinstance(rclone, Rclone)
+    # if str then it will be remote:path
+    if isinstance(item, str):
+        # return RPath(item)
+        # remote_name: str = item.split(":")[0]
+        parts = item.split(":")
+        remote_name = parts[0]
+        path = ":".join(parts[1:])
+        remote = Remote(name=remote_name, rclone=rclone)
+        return RPath(
+            remote=remote,
+            path=path,
+            name="",
+            size=0,
+            mime_type="",
+            mod_time="",
+            is_dir=True,
+        )
+    elif isinstance(item, Dir):
+        return item.path
+    elif isinstance(item, Remote):
+        return RPath(
+            remote=item,
+            path=str(item),
+            name=str(item),
+            size=0,
+            mime_type="inode/directory",
+            mod_time="",
+            is_dir=True,
+        )
+    else:
+        raise ValueError(f"Invalid type for item: {type(item)}")
+
+
+def _get_verbose(verbose: bool | None) -> bool:
+    if verbose is not None:
+        return verbose
+    # get it from the environment
+    return bool(int(os.getenv("RCLONE_API_VERBOSE", "0")))
+
 
 def get_rclone_exe(rclone_exe: Path | None) -> Path:
     if rclone_exe is None:
@@ -20,10 +71,11 @@ def rclone_execute(
     cmd: list[str],
     rclone_conf: Path | Config,
     rclone_exe: Path,
-    verbose: bool = False,
+    verbose: bool | None = None,
 ) -> subprocess.CompletedProcess:
-    print(subprocess.list2cmdline(cmd))
     tempdir: TemporaryDirectory | None = None
+    verbose = _get_verbose(verbose)
+    assert verbose is not None
 
     try:
         if isinstance(rclone_conf, Config):

rclone_api-1.0.13.dist-info/METADATA

@@ -0,0 +1,34 @@
+Metadata-Version: 2.2
+Name: rclone_api
+Version: 1.0.13
+Summary: rclone api in python
+Home-page: https://github.com/zackees/rclone-api
+Maintainer: Zachary Vorhies
+License: BSD 3-Clause License
+Keywords: template-python-cmd
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dotenv>=1.0.0
+Dynamic: home-page
+Dynamic: maintainer
+
+# rclone-api
+
+[![Linting](https://github.com/zackees/rclone-api/actions/workflows/lint.yml/badge.svg)](https://github.com/zackees/rclone-api/actions/workflows/lint.yml)
+[![MacOS_Tests](https://github.com/zackees/rclone-api/actions/workflows/push_macos.yml/badge.svg)](https://github.com/zackees/rclone-api/actions/workflows/push_macos.yml)
+[![Ubuntu_Tests](https://github.com/zackees/rclone-api/actions/workflows/push_ubuntu.yml/badge.svg)](https://github.com/zackees/rclone-api/actions/workflows/push_ubuntu.yml)
+[![Win_Tests](https://github.com/zackees/rclone-api/actions/workflows/push_win.yml/badge.svg)](https://github.com/zackees/rclone-api/actions/workflows/push_win.yml)
+
+Api version of rclone. It's well tested. It's just released so this readme is a little to be desired.
+
+To develop software, run `. ./activate`
+
+# Windows
+
+This environment requires you to use `git-bash`.
+
+# Linting
+
+Run `./lint`

{rclone_api-1.0.11.dist-info → rclone_api-1.0.13.dist-info}/RECORD

@@ -1,18 +1,18 @@
 rclone_api/__init__.py,sha256=YH7KQaPwUiJWJiRf0NRKD7XHhMXsxWdXDjt9WLSwdjA,265
 rclone_api/cli.py,sha256=dibfAZIh0kXWsBbfp3onKLjyZXo54mTzDjUdzJlDlWo,231
 rclone_api/config.py,sha256=UujjDNcpwgipgdyFPMhC3zikvlsrurUvvZiwXm5NlPg,471
-rclone_api/dir.py,sha256=6rOjqBkITzA0nZE9aIZ15HbCbVDgxluM-LxhSrYrNXU,1487
+rclone_api/dir.py,sha256=tu0-Yy1s3O1MVY7Nkb6NOh6t9dXJ9DQvqOZVlWIexrI,1629
 rclone_api/dir_listing.py,sha256=NWleKHCCRW7_eh9JfRwE6r3QbjmiHD5ZEGQcd2vm4uY,458
-rclone_api/file.py,sha256=409neYPfCUKQX2w7Uw7_D0wR2PtH42srNe9u_nnOLxM,925
-rclone_api/rclone.py,sha256=EUsLW5qcipI5RzhpHUd0PQqQow43m2uKJmNgVR8ZBuU,2859
+rclone_api/file.py,sha256=nJwJT7v2KwY_8g7UB3Y7O6pFfHn3nri9dJ3GS-cN3EE,874
+rclone_api/rclone.py,sha256=upMqUxYKC3LCjHlhI66_IdOD1t5PKo7V64sSdw0vAlk,3074
 rclone_api/remote.py,sha256=c9hlRKBCg1BFB9MCINaQIoCg10qyAkeqiS4brl8ce-8,343
-rclone_api/rpath.py,sha256=_k59z-O75hAhpPyUSH4glPEoiYtIS3RUQb7ltU9Ianw,2009
+rclone_api/rpath.py,sha256=QHD5zDjDIkivs3kCRYtTL8mP-DspXIvBVYWHSf_Y6Rg,2263
 rclone_api/types.py,sha256=Yp15HrjwZonSQhE323R0WP7fA4NWqKjAfM7z3OwHpWI,518
-rclone_api/util.py,sha256=EXnijLLdFHqwoZvHrZdqeM8r6T7ad9-pN7qBN1b0I_g,1465
+rclone_api/util.py,sha256=xYUj0B9W5HDauTHh7Z8cnEQsTEuXvRcVNLtk3ZanlGM,2894
 rclone_api/walk.py,sha256=3GKnu9P5aPNiftfoi52U7wo1wixZxwxdqqS0_IlMGCE,2816
 rclone_api/assets/example.txt,sha256=lTBovRjiz0_TgtAtbA1C5hNi2ffbqnNPqkKg6UiKCT8,54
-rclone_api-1.0.11.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
-rclone_api-1.0.11.dist-info/METADATA,sha256=kS-htI-Jrl56FEYxndEQm7JRmSWxHP5UpgDG9FL14_w,1245
-rclone_api-1.0.11.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
-rclone_api-1.0.11.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
-rclone_api-1.0.11.dist-info/RECORD,,
+rclone_api-1.0.13.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
+rclone_api-1.0.13.dist-info/METADATA,sha256=yEL4GNzAc-CwJt-rJVmDAl08L13RqytSSs1ZQR4KMA0,1375
+rclone_api-1.0.13.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
+rclone_api-1.0.13.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
+rclone_api-1.0.13.dist-info/RECORD,,

rclone_api-1.0.11.dist-info/METADATA

@@ -1,36 +0,0 @@
-Metadata-Version: 2.2
-Name: rclone_api
-Version: 1.0.11
-Summary: rclone api in python
-Home-page: https://github.com/zackees/rclone-api
-Maintainer: Zachary Vorhies
-License: BSD 3-Clause License
-Keywords: template-python-cmd
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: home-page
-Dynamic: maintainer
-
-# template-python-cmd
-A template for quickly making a python lib that has a command line program attached
-
-[![Linting](../../actions/workflows/lint.yml/badge.svg)](../../actions/workflows/lint.yml)
-
-[![MacOS_Tests](../../actions/workflows/push_macos.yml/badge.svg)](../../actions/workflows/push_macos.yml)
-[![Ubuntu_Tests](../../actions/workflows/push_ubuntu.yml/badge.svg)](../../actions/workflows/push_ubuntu.yml)
-[![Win_Tests](../../actions/workflows/push_win.yml/badge.svg)](../../actions/workflows/push_win.yml)
-
-Replace `template-python-cmd` and `template_python_cmd` with your command. Run tox until it's
-correct.
-
-To develop software, run `. ./activate.sh`
-
-# Windows
-
-This environment requires you to use `git-bash`.
-
-# Linting
-
-Run `./lint.sh` to find linting errors using `pylint`, `flake8` and `mypy`.