rclone-api 1.0.2__tar.gz → 1.0.4__tar.gz

{rclone_api-1.0.2 → rclone_api-1.0.4}/.gitignore

@@ -139,3 +139,4 @@ activate
 # Generated by mac
 **/.DS_Store
 uv.lock
+.aider*

{rclone_api-1.0.2/src/rclone_api.egg-info → rclone_api-1.0.4}/PKG-INFO

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

{rclone_api-1.0.2 → rclone_api-1.0.4}/pyproject.toml

@@ -14,7 +14,7 @@ dependencies = [
 
 ]
 # Change this with the version number bump.
-version = "1.0.2"
+version = "1.0.4"
 
 [tool.setuptools]
 package-dir = {"" = "src"}

rclone_api-1.0.4/src/rclone_api/__init__.py

@@ -0,0 +1,8 @@
+from .dir import Dir
+from .file import File
+from .rclone import Rclone
+from .remote import Remote
+from .rpath import RPath
+from .types import Config
+
+__all__ = ["Rclone", "File", "Config", "Remote", "Dir", "RPath"]

rclone_api-1.0.4/src/rclone_api/config.py

@@ -0,0 +1,19 @@
+import subprocess
+from dataclasses import dataclass
+from pathlib import Path
+
+from rclone_api.types import Config
+
+
+@dataclass
+class RcloneExec:
+    """Rclone execution dataclass."""
+
+    rclone_config: Path | Config
+    rclone_exe: Path
+
+    def execute(self, cmd: list[str]) -> subprocess.CompletedProcess:
+        """Execute rclone command."""
+        from rclone_api.util import rclone_execute
+
+        return rclone_execute(cmd, self.rclone_config, self.rclone_exe)

rclone_api-1.0.4/src/rclone_api/dir.py

@@ -0,0 +1,27 @@
+from rclone_api.file import File
+from rclone_api.rpath import RPath
+
+
+class Dir:
+    """Remote file dataclass."""
+
+    def __init__(self, path: RPath) -> None:
+        self.path = path
+
+    def ls(self) -> tuple[list["Dir"], list[File]]:
+        """List files and directories in the given path."""
+        cmd = ["lsjson", "--files-only", "--dirs-only", "--json", str(self.path)]
+        assert self.path.rclone is not None
+        cp = self.path.rclone._run(cmd)
+        text = cp.stdout
+        tmp: list[RPath] = RPath.from_json_str(text)
+        for t in tmp:
+            t.set_rclone(self.path.rclone)
+        # dirs = [o for o in out if o.is_dir]
+        # files = [o for o in out if not o.is_dir]
+        dirs = [Dir(p) for p in tmp if p.is_dir]
+        files = [File(p) for p in tmp if not p.is_dir]
+        return dirs, files
+
+    def __str__(self) -> str:
+        return str(self.path)

rclone_api-1.0.4/src/rclone_api/file.py

@@ -0,0 +1,35 @@
+import json
+
+from rclone_api.rpath import RPath
+
+
+class File:
+    """Remote file dataclass."""
+
+    def __init__(
+        self,
+        path: RPath,
+    ) -> None:
+        self.path = path
+
+    def read_text(self) -> str:
+        """Read the file contents as bytes.
+
+        Returns:
+            bytes: The file contents
+
+        Raises:
+            RuntimeError: If no rclone instance is associated with this file
+            RuntimeError: If the path represents a directory
+        """
+        if self.path.rclone is None:
+            raise RuntimeError("No rclone instance associated with this file")
+        if self.path.is_dir:
+            raise RuntimeError("Cannot read a directory as bytes")
+
+        result = self.path.rclone._run(["cat", self.path.path])
+        return result.stdout
+
+    def __str__(self) -> str:
+        out = self.path.to_json()
+        return json.dumps(out)

{rclone_api-1.0.2 → rclone_api-1.0.4}/src/rclone_api/rclone.py

@@ -1,43 +1,57 @@
-"""
-Unit test file.
-"""
-
-import subprocess
-from pathlib import Path
-
-from rclone_api.file import File
-from rclone_api.types import Config, RcloneExec, Remote
-from rclone_api.util import get_rclone_exe
-
-
-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) -> list[File]:
-        cmd = ["lsjson", str(path)]
-        cp = self._run(cmd)
-        text = cp.stdout
-        out: list[File] = File.from_json_str(text)
-        for o in out:
-            o.set_rclone(self)
-        return out
-
-    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) for t in tmp]
-        return out
+"""
+Unit test file.
+"""
+
+import subprocess
+from pathlib import Path
+
+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
+
+
+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) -> list[RPath]:
+        """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
+        out: list[RPath] = RPath.from_json_str(text)
+        for o in out:
+            o.set_rclone(self)
+        return out
+
+    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) for t in tmp]
+        return out

rclone_api-1.0.4/src/rclone_api/remote.py

@@ -0,0 +1,8 @@
+class Remote:
+    """Remote dataclass."""
+
+    def __init__(self, name: str) -> None:
+        self.name = name
+
+    def __str__(self) -> str:
+        return f"{self.name}:"

rclone_api-1.0.2/src/rclone_api/file.py → rclone_api-1.0.4/src/rclone_api/rpath.py

@@ -1,8 +1,9 @@
 import json
+from pathlib import Path
 from typing import Any
 
 
-class File:
+class RPath:
     """Remote file dataclass."""
 
     def __init__(
@@ -32,9 +33,9 @@ class File:
         self.rclone = rclone
 
     @staticmethod
-    def from_dict(data: dict) -> "File":
+    def from_dict(data: dict) -> "RPath":
         """Create a File from a dictionary."""
-        return File(
+        return RPath(
             data["Path"],
             data["Name"],
             data["Size"],
@@ -45,21 +46,21 @@ class File:
         )
 
     @staticmethod
-    def from_array(data: list[dict]) -> list["File"]:
+    def from_array(data: list[dict]) -> list["RPath"]:
         """Create a File from a dictionary."""
-        out: list[File] = []
+        out: list[RPath] = []
         for d in data:
-            file: File = File.from_dict(d)
+            file: RPath = RPath.from_dict(d)
             out.append(file)
         return out
 
     @staticmethod
-    def from_json_str(json_str: str) -> list["File"]:
+    def from_json_str(json_str: str) -> list["RPath"]:
         """Create a File from a JSON string."""
         json_obj = json.loads(json_str)
         if isinstance(json_obj, dict):
-            return [File.from_dict(json_obj)]
-        return File.from_array(json_obj)
+            return [RPath.from_dict(json_obj)]
+        return RPath.from_array(json_obj)
 
     def to_json(self) -> dict:
         return {
@@ -72,6 +73,41 @@ class File:
             # "IsBucket": self.is_bucket,
         }
 
+    def read_text(self) -> str:
+        """Read the file contents as bytes.
+
+        Returns:
+            bytes: The file contents
+
+        Raises:
+            RuntimeError: If no rclone instance is associated with this file
+            RuntimeError: If the path represents a directory
+        """
+        if self.rclone is None:
+            raise RuntimeError("No rclone instance associated with this file")
+        if self.is_dir:
+            raise RuntimeError("Cannot read a directory as bytes")
+
+        result = self.rclone._run(["cat", self.path])
+        return result.stdout
+
+    def read(self, dest: Path) -> None:
+        """Copy the remote file to a local destination path.
+
+        Args:
+            dest: Local destination path where the file will be copied
+
+        Raises:
+            RuntimeError: If no rclone instance is associated with this file
+            RuntimeError: If the path represents a directory
+        """
+        if self.rclone is None:
+            raise RuntimeError("No rclone instance associated with this file")
+        if self.is_dir:
+            raise RuntimeError("Cannot read a directory as a file")
+
+        self.rclone._run(["copyto", self.path, str(dest)])
+
     def __str__(self) -> str:
         out = self.to_json()
         return json.dumps(out)

{rclone_api-1.0.2 → rclone_api-1.0.4}/src/rclone_api/types.py

@@ -22,13 +22,3 @@ class RcloneExec:
         from rclone_api.util import rclone_execute
 
         return rclone_execute(cmd, self.rclone_config, self.rclone_exe)
-
-
-class Remote:
-    """Remote dataclass."""
-
-    def __init__(self, name: str) -> None:
-        self.name = name
-
-    def __str__(self) -> str:
-        return f"{self.name}:"

{rclone_api-1.0.2 → rclone_api-1.0.4/src/rclone_api.egg-info}/PKG-INFO

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

{rclone_api-1.0.2 → rclone_api-1.0.4}/src/rclone_api.egg-info/SOURCES.txt

@@ -17,8 +17,12 @@ upload_package.sh
 .vscode/tasks.json
 src/rclone_api/__init__.py
 src/rclone_api/cli.py
+src/rclone_api/config.py
+src/rclone_api/dir.py
 src/rclone_api/file.py
 src/rclone_api/rclone.py
+src/rclone_api/remote.py
+src/rclone_api/rpath.py
 src/rclone_api/types.py
 src/rclone_api/util.py
 src/rclone_api.egg-info/PKG-INFO

rclone_api-1.0.2/src/rclone_api/__init__.py

@@ -1,4 +0,0 @@
-from .rclone import File, Rclone
-from .types import Config, Remote
-
-__all__ = ["Rclone", "File", "Config", "Remote"]