rclone-api 1.0.22__py2.py3-none-any.whl → 1.0.24__py2.py3-none-any.whl

rclone_api/cmd/list_files.py

@@ -0,0 +1,27 @@
+import argparse
+from pathlib import Path
+
+from rclone_api import Rclone
+
+
+def list_files(rclone: Rclone, path: str):
+    """List files in a remote path."""
+    for dirlisting in rclone.walk(path):
+        for file in dirlisting.files:
+            print(file.path)
+
+
+def _parse_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(description="List files in a remote path.")
+    parser.add_argument("--config", help="Path to rclone config file", required=True)
+    parser.add_argument("path", help="Remote path to list")
+    return parser.parse_args()
+
+
+def main() -> int:
+    """Main entry point."""
+    args = _parse_args()
+    path = args.path
+    rclone = Rclone(Path(args.config))
+    list_files(rclone, path)
+    return 0

rclone_api/rclone.py

@@ -6,6 +6,7 @@ import subprocess
 import time
 import warnings
 from concurrent.futures import ThreadPoolExecutor
+from enum import Enum
 from fnmatch import fnmatch
 from pathlib import Path
 from typing import Generator
@@ -23,6 +24,11 @@ from rclone_api.util import get_rclone_exe, to_path, wait_for_mount
 from rclone_api.walk import walk
 
 
+class ModTimeStrategy(Enum):
+    USE_SERVER_MODTIME = "use-server-modtime"
+    NO_MODTIME = "no-modtime"
+
+
 class Rclone:
     def __init__(
         self, rclone_conf: Path | Config, rclone_exe: Path | None = None
@@ -299,6 +305,7 @@ class Rclone:
         url: str,
         outdir: Path,
         vfs_cache_mode="full",
+        vfs_disk_space_total_size: str | None = "10G",
         other_cmds: list[str] | None = None,
     ) -> Process:
         """Mount a remote or directory to a local path.
@@ -327,10 +334,55 @@ class Rclone:
         cmd_list.append(vfs_cache_mode)
         if other_cmds:
             cmd_list += other_cmds
+        if vfs_disk_space_total_size is not None:
+            cmd_list.append("--vfs-cache-max-size")
+            cmd_list.append(vfs_disk_space_total_size)
         proc = self._launch_process(cmd_list)
         wait_for_mount(outdir, proc)
         return proc
 
+    def mount_s3(
+        self,
+        url: str,
+        outdir: Path,
+        vfs_cache_mode="full",
+        transfers: int | None = 16,
+        modtime_strategy: (
+            ModTimeStrategy | None
+        ) = ModTimeStrategy.USE_SERVER_MODTIME,  # speeds up S3 operations
+        vfs_read_chunk_streams: int | None = 16,
+        vfs_read_chunk_size: str | None = "4M",
+        vfs_fast_fingerprint: bool = True,
+        other_cmds: list[str] | None = None,
+    ) -> Process:
+        """Mount a remote or directory to a local path.
+
+        Args:
+            src: Remote or directory to mount
+            outdir: Local path to mount to
+        """
+        other_cmds = other_cmds or []
+        if modtime_strategy is not None:
+            other_cmds.append(f"--{modtime_strategy.value}")
+        if (vfs_cache_mode == "full" or vfs_cache_mode == "writes") and (
+            transfers is not None
+        ):
+            other_cmds.append("--transfers")
+            other_cmds.append(str(transfers))
+        if vfs_read_chunk_streams:
+            other_cmds.append("--vfs-read-chunk-streams")
+            other_cmds.append(str(vfs_read_chunk_streams))
+        if vfs_read_chunk_size:
+            other_cmds.append("--vfs-read-chunk-size")
+            other_cmds.append(vfs_read_chunk_size)
+        if vfs_fast_fingerprint:
+            other_cmds.append("--vfs-fast-fingerprint")
+
+        other_cmds = other_cmds if other_cmds else None
+        return self.mount(
+            url, outdir, vfs_cache_mode=vfs_cache_mode, other_cmds=other_cmds
+        )
+
     def serve_webdav(
         self,
         src: Remote | Dir | str,

{rclone_api-1.0.22.dist-info → rclone_api-1.0.24.dist-info}/METADATA

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

{rclone_api-1.0.22.dist-info → rclone_api-1.0.24.dist-info}/RECORD

@@ -8,14 +8,16 @@ rclone_api/exec.py,sha256=9qSOpZo8YRYxv3hOvNr57ApnY2KbjxwT1QNr8OgcLM4,883
 rclone_api/file.py,sha256=D02iHJW1LhfOiM_R_yPHP8_ApnDiYrkuraVcrV8-qkw,1246
 rclone_api/filelist.py,sha256=xbiusvNgaB_b_kQOZoHMJJxn6TWGtPrWd2J042BI28o,767
 rclone_api/process.py,sha256=iVA8_qtJFgHtg92Yb4W7xv9jnyds_7kAdKeSiGCBIZ0,3952
-rclone_api/rclone.py,sha256=RBlEi7M8Jpgt8oJcV-2VrhF-iVAtGlpfBJ7YXGjPS_s,12649
+rclone_api/rclone.py,sha256=jNZVeTPyNH2BwGsA7OIs18PkMSBOmQLxS0yz6dHlkAU,14596
 rclone_api/remote.py,sha256=c9hlRKBCg1BFB9MCINaQIoCg10qyAkeqiS4brl8ce-8,343
 rclone_api/rpath.py,sha256=8ZA_1wxWtskwcy0I8V2VbjKDmzPkiWd8Q2JQSvh-sYE,2586
 rclone_api/util.py,sha256=AWTImA1liCMw52wtS-Gs8Abz96diQ39x6Tx56mvbrEo,3860
 rclone_api/walk.py,sha256=kca0t1GAnF6FLclN01G8NG__Qe-ggodLtAbQSHyVPng,2968
 rclone_api/assets/example.txt,sha256=lTBovRjiz0_TgtAtbA1C5hNi2ffbqnNPqkKg6UiKCT8,54
-rclone_api-1.0.22.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
-rclone_api-1.0.22.dist-info/METADATA,sha256=dl2QJr1Q_oRiRNLB9gC-ZWAbCgHUxqUm-cdBVjPEFnI,4454
-rclone_api-1.0.22.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
-rclone_api-1.0.22.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
-rclone_api-1.0.22.dist-info/RECORD,,
+rclone_api/cmd/list_files.py,sha256=x8FHODEilwKqwdiU1jdkeJbLwOqUkUQuDWPo2u_zpf0,741
+rclone_api-1.0.24.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
+rclone_api-1.0.24.dist-info/METADATA,sha256=6Kv_3ixSg65E3cPLSATze1pRx_O2JMqcxbtDNDC7_cA,4454
+rclone_api-1.0.24.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
+rclone_api-1.0.24.dist-info/entry_points.txt,sha256=XUoTX3m7CWxdj2VAKhEuO0NMOfX2qf-OcEDFwdyk9ZE,72
+rclone_api-1.0.24.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
+rclone_api-1.0.24.dist-info/RECORD,,

rclone_api-1.0.24.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+rclone-api-listfiles = rclone_api.cmd.list_files:main