rclone-api 1.0.12__tar.gz → 1.0.14__tar.gz

rclone_api-1.0.14/.github/workflows/lint.yml

@@ -0,0 +1,35 @@
+name: Linting
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.11]
+        os: [ubuntu-latest]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - uses: actions/cache@v4
+      name: Configure pip caching
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+
+    - name: Install
+      run: |
+        python -m pip install uv
+        ./install
+    - name: Run Linting
+      run: |
+        ./lint

rclone_api-1.0.14/.github/workflows/push_macos.yml

@@ -0,0 +1,32 @@
+name: MacOS_Tests
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.11]
+        os: [macos-latest]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - uses: actions/cache@v4
+      name: Configure pip caching
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+    - name: Install
+      run: |
+        ./install
+    - name: Run Tests
+      run: |
+        ./test

rclone_api-1.0.14/.github/workflows/push_ubuntu.yml

@@ -0,0 +1,32 @@
+name: Ubuntu_Tests
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.11]
+        os: [ubuntu-latest]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - uses: actions/cache@v4
+      name: Configure pip caching
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+    - name: Install
+      run: |
+        ./install
+    - name: Run Tests
+      run: |
+        ./test

rclone_api-1.0.14/.github/workflows/push_win.yml

@@ -0,0 +1,34 @@
+name: Win_Tests
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.11]
+        os: [windows-latest]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - uses: actions/cache@v4
+      name: Configure pip caching
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+    - name: Install
+      run: |
+        ./install
+      shell: bash
+    - name: Run Tests
+      run: |
+        ./test
+      shell: bash

rclone_api-1.0.14/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.2
+Name: rclone_api
+Version: 1.0.14
+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.14/README.md

@@ -0,0 +1,18 @@
+# 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.12 → rclone_api-1.0.14}/pyproject.toml

@@ -1,44 +1,44 @@
-[build-system]
-requires = ["setuptools>=65.5.1", "setuptools-scm", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "rclone_api"
-readme = "README.md"
-description = "rclone api in python"
-requires-python = ">=3.7"
-keywords = ["template-python-cmd"]
-license = { text = "BSD 3-Clause License" }
-classifiers = ["Programming Language :: Python :: 3"]
-dependencies = [
-
-]
-# Change this with the version number bump.
-version = "1.0.12"
-
-[tool.setuptools]
-package-dir = {"" = "src"}
-
-[tool.ruff]
-line-length = 200
-
-[tool.pylint."MESSAGES CONTROL"]
-good-names = [
-    "c",
-    "i",
-    "ok",
-    "id",
-    "e",
-    "f"
-]
-disable = [
-    "missing-function-docstring",
-    "missing-module-docstring"
-]
-
-[tool.isort]
-profile = "black"
-
-[tool.mypy]
-ignore_missing_imports = true
-disable_error_code = ["import-untyped"]
+[build-system]
+requires = ["setuptools>=65.5.1", "setuptools-scm", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rclone_api"
+readme = "README.md"
+description = "rclone api in python"
+requires-python = ">=3.10"
+keywords = ["template-python-cmd"]
+license = { text = "BSD 3-Clause License" }
+classifiers = ["Programming Language :: Python :: 3"]
+dependencies = [
+    "python-dotenv>=1.0.0"
+]
+# Change this with the version number bump.
+version = "1.0.14"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.ruff]
+line-length = 200
+
+[tool.pylint."MESSAGES CONTROL"]
+good-names = [
+    "c",
+    "i",
+    "ok",
+    "id",
+    "e",
+    "f"
+]
+disable = [
+    "missing-function-docstring",
+    "missing-module-docstring"
+]
+
+[tool.isort]
+profile = "black"
+
+[tool.mypy]
+ignore_missing_imports = true
+disable_error_code = ["import-untyped"]

{rclone_api-1.0.12 → rclone_api-1.0.14}/src/rclone_api/__init__.py

@@ -1,9 +1,9 @@
+from .config import Config
 from .dir import Dir
 from .dir_listing import DirListing
 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", "DirListing"]

rclone_api-1.0.14/src/rclone_api/config.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class Config:
+    """Rclone configuration dataclass."""
+
+    text: str

rclone_api-1.0.14/src/rclone_api/convert.py

@@ -0,0 +1,31 @@
+from rclone_api.dir import Dir
+from rclone_api.file import File
+from rclone_api.remote import Remote
+
+
+def convert_to_filestr_list(files: str | File | list[str] | list[File]) -> list[str]:
+    out: list[str] = []
+    if isinstance(files, str):
+        out.append(files)
+    elif isinstance(files, File):
+        out.append(str(files.path))
+    elif isinstance(files, list):
+        for f in files:
+            if isinstance(f, File):
+                f = str(f.path)
+            out.append(f)
+    else:
+        raise ValueError(f"Invalid type for file: {type(files)}")
+    return out
+
+
+def convert_to_str(file_or_dir: str | File | Dir | Remote) -> str:
+    if isinstance(file_or_dir, str):
+        return file_or_dir
+    if isinstance(file_or_dir, File):
+        return str(file_or_dir.path)
+    if isinstance(file_or_dir, Dir):
+        return str(file_or_dir.path)
+    if isinstance(file_or_dir, Remote):
+        return str(file_or_dir)
+    raise ValueError(f"Invalid type for file_or_dir: {type(file_or_dir)}")

{rclone_api-1.0.12 → rclone_api-1.0.14}/src/rclone_api/dir.py

@@ -1,3 +1,4 @@
+import json
 from typing import Generator
 
 from rclone_api.dir_listing import DirListing
@@ -8,6 +9,14 @@ from rclone_api.rpath import RPath
 class Dir:
     """Remote file dataclass."""
 
+    @property
+    def remote(self) -> Remote:
+        return self.path.remote
+
+    @property
+    def name(self) -> str:
+        return self.path.name
+
     def __init__(self, path: RPath | Remote) -> None:
         """Initialize Dir with either an RPath or Remote.
 
@@ -17,6 +26,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,
@@ -28,11 +38,14 @@ class Dir:
             self.path.set_rclone(path.rclone)
         else:
             self.path = path
+        # self.path.set_rclone(self.path.remote.rclone)
+        assert self.path.rclone is not None
 
     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."""
@@ -41,5 +54,14 @@ class Dir:
         assert self.path.rclone is not None
         return walk(self, max_depth=max_depth)
 
+    def to_json(self) -> dict:
+        """Convert the Dir to a JSON serializable dictionary."""
+        return self.path.to_json()
+
     def __str__(self) -> str:
         return str(self.path)
+
+    def __repr__(self) -> str:
+        data = self.path.to_json()
+        data_str = json.dumps(data)
+        return data_str

rclone_api-1.0.14/src/rclone_api/dir_listing.py

@@ -0,0 +1,40 @@
+import json
+
+from rclone_api.rpath import RPath
+
+
+class DirListing:
+    """Remote file dataclass."""
+
+    def __init__(self, dirs_and_files: list[RPath]) -> None:
+        from rclone_api.dir import Dir
+        from rclone_api.file import File
+
+        self.dirs: list[Dir] = [Dir(d) for d in dirs_and_files if d.is_dir]
+        self.files: list[File] = [File(f) for f in dirs_and_files if not f.is_dir]
+
+    def __str__(self) -> str:
+        n_files = len(self.files)
+        n_dirs = len(self.dirs)
+        msg = f"Files: {n_files}\n"
+        if n_files > 0:
+            for f in self.files:
+                msg += f"  {f}\n"
+        msg += f"Dirs: {n_dirs}\n"
+        if n_dirs > 0:
+            for d in self.dirs:
+                msg += f"  {d}\n"
+        return msg
+
+    def __repr__(self) -> str:
+        dirs: list = []
+        files: list = []
+        for d in self.dirs:
+            dirs.append(d.path.to_json())
+        for f in self.files:
+            files.append(f.path.to_json())
+        json_obj = {
+            "dirs": dirs,
+            "files": files,
+        }
+        return json.dumps(json_obj, indent=2)

rclone_api-1.0.12/src/rclone_api/config.py → rclone_api-1.0.14/src/rclone_api/exec.py

@@ -2,7 +2,7 @@ import subprocess
 from dataclasses import dataclass
 from pathlib import Path
 
-from rclone_api.types import Config
+from rclone_api.config import Config
 
 
 @dataclass

{rclone_api-1.0.12 → rclone_api-1.0.14}/src/rclone_api/file.py

@@ -12,6 +12,10 @@ class File:
     ) -> None:
         self.path = path
 
+    @property
+    def name(self) -> str:
+        return self.path.name
+
     def read_text(self) -> str:
         """Read the file contents as bytes.
 
@@ -30,6 +34,14 @@ class File:
         result = self.path.rclone._run(["cat", self.path.path])
         return result.stdout
 
+    def to_json(self) -> dict:
+        """Convert the File to a JSON serializable dictionary."""
+        return self.path.to_json()
+
     def __str__(self) -> str:
-        out = self.path.to_json()
-        return json.dumps(out)
+        return str(self.path)
+
+    def __repr__(self) -> str:
+        data = self.path.to_json()
+        data_str = json.dumps(data)
+        return data_str

rclone_api-1.0.14/src/rclone_api/rclone.py

@@ -0,0 +1,214 @@
+"""
+Unit test file.
+"""
+
+import subprocess
+from concurrent.futures import ThreadPoolExecutor
+from fnmatch import fnmatch
+from pathlib import Path
+from typing import Generator
+
+from rclone_api import Dir
+from rclone_api.config import Config
+from rclone_api.convert import convert_to_filestr_list, convert_to_str
+from rclone_api.dir_listing import DirListing
+from rclone_api.exec import RcloneExec
+from rclone_api.file import File
+from rclone_api.remote import Remote
+from rclone_api.rpath import RPath
+from rclone_api.util import get_rclone_exe, to_path
+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,
+        glob: str | 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
+        """
+
+        if isinstance(path, str):
+            path = Dir(
+                to_path(path, self)
+            )  # assume it's a directory if ls is being called.
+
+        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
+        parent_path: str | None = None
+        if isinstance(path, Dir):
+            parent_path = path.path.path
+        paths: list[RPath] = RPath.from_json_str(text, remote, parent_path=parent_path)
+        # print(parent_path)
+        for o in paths:
+            o.set_rclone(self)
+
+        # do we have a glob pattern?
+        if glob is not None:
+            paths = [p for p in paths if fnmatch(p.path, glob)]
+        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 | str, 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)
+        elif isinstance(path, str):
+            dir_obj = Dir(to_path(path, self))
+        elif isinstance(path, Remote):
+            dir_obj = Dir(path)
+        else:
+            assert f"Invalid type for path: {type(path)}"
+
+        yield from walk(dir_obj, max_depth=max_depth)
+
+    def copyfile(self, src: File | str, dst: File | str) -> None:
+        """Copy a single file from source to destination.
+
+        Args:
+            src: Source file path (including remote if applicable)
+            dst: Destination file path (including remote if applicable)
+
+        Raises:
+            subprocess.CalledProcessError: If the copy operation fails
+        """
+        src = src if isinstance(src, str) else str(src.path)
+        dst = dst if isinstance(dst, str) else str(dst.path)
+        cmd_list: list[str] = ["copyto", src, dst]
+        self._run(cmd_list)
+
+    def copyfiles(self, filelist: dict[File, File] | dict[str, str]) -> None:
+        """Copy multiple files from source to destination.
+
+        Warning - slow.
+
+        Args:
+            payload: Dictionary of source and destination file paths
+        """
+        str_dict: dict[str, str] = {}
+        for src, dst in filelist.items():
+            src = src if isinstance(src, str) else str(src.path)
+            dst = dst if isinstance(dst, str) else str(dst.path)
+            str_dict[src] = dst
+
+        with ThreadPoolExecutor(max_workers=64) as executor:
+            for src, dst in str_dict.items():  # warning - slow
+                cmd_list: list[str] = ["copyto", src, dst]
+                # self._run(cmd_list)
+                executor.submit(self._run, cmd_list)
+
+    def copy(self, src: Dir, dst: Dir) -> None:
+        """Copy files from source to destination.
+
+        Args:
+            src: Source directory
+            dst: Destination directory
+        """
+        src_dir = src.path.path
+        dst_dir = dst.path.path
+        cmd_list: list[str] = ["copy", src_dir, dst_dir]
+        self._run(cmd_list)
+
+    def purge(self, path: Dir | str) -> None:
+        """Purge a directory"""
+        # path should always be a string
+        path = path if isinstance(path, str) else str(path.path)
+        cmd_list: list[str] = ["purge", str(path)]
+        self._run(cmd_list)
+
+    def deletefiles(self, files: str | File | list[str] | list[File]) -> None:
+        """Delete a directory"""
+        payload: list[str] = convert_to_filestr_list(files)
+        cmd_list: list[str] = ["delete"] + payload
+        self._run(cmd_list)
+
+    def exists(self, path: Dir | Remote | str | File) -> bool:
+        """Check if a file or directory exists."""
+        arg: str = convert_to_str(path)
+        assert isinstance(arg, str)
+        try:
+            self.ls(arg)
+            return True
+        except subprocess.CalledProcessError:
+            return False
+
+    def is_synced(self, src: str | Dir, dst: str | Dir) -> bool:
+        """Check if two directories are in sync."""
+        src = convert_to_str(src)
+        dst = convert_to_str(dst)
+        cmd_list: list[str] = ["check", str(src), str(dst)]
+        try:
+            self._run(cmd_list)
+            return True
+        except subprocess.CalledProcessError:
+            return False
+
+    def copy_dir(self, src: str | Dir, dst: str | Dir) -> None:
+        """Copy a directory from source to destination."""
+        # convert src to str, also dst
+        src = convert_to_str(src)
+        dst = convert_to_str(dst)
+        cmd_list: list[str] = ["copy", src, dst]
+        self._run(cmd_list)