rclone-api 1.0.21__tar.gz → 1.0.23__tar.gz

{rclone_api-1.0.21 → rclone_api-1.0.23}/PKG-INFO

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

{rclone_api-1.0.21 → rclone_api-1.0.23}/pyproject.toml

@@ -15,7 +15,7 @@ dependencies = [
     "python-dotenv>=1.0.0",
 ]
 # Change this with the version number bump.
-version = "1.0.21"
+version = "1.0.23"
 
 [tool.setuptools]
 package-dir = {"" = "src"}
@@ -43,3 +43,6 @@ profile = "black"
 [tool.mypy]
 ignore_missing_imports = true
 disable_error_code = ["import-untyped"]
+
+ [project.scripts]
+ rclone-api-listfiles = "rclone_api.cmd.list_files:main"

rclone_api-1.0.23/src/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-1.0.21 → rclone_api-1.0.23}/src/rclone_api/rclone.py

@@ -19,7 +19,7 @@ from rclone_api.file import File
 from rclone_api.process import Process
 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.util import get_rclone_exe, to_path, wait_for_mount
 from rclone_api.walk import walk
 
 
@@ -291,9 +291,7 @@ class Rclone:
         if other_cmds:
             cmd_list += other_cmds
         proc = self._launch_process(cmd_list)
-        time.sleep(2)  # give it a moment to mount
-        if proc.poll() is not None:
-            raise ValueError("Mount process failed to start")
+        wait_for_mount(outdir, proc)
         return proc
 
     def mount_webdav(
@@ -330,10 +328,7 @@ class Rclone:
         if other_cmds:
             cmd_list += other_cmds
         proc = self._launch_process(cmd_list)
-        # proc = rclone_exec.launch_process(cmd_list)
-        time.sleep(2)
-        if proc.poll() is not None:
-            raise ValueError("Mount process failed to start")
+        wait_for_mount(outdir, proc)
         return proc
 
     def serve_webdav(

{rclone_api-1.0.21 → rclone_api-1.0.23}/src/rclone_api/util.py

@@ -1,6 +1,7 @@
 import os
 import shutil
 import subprocess
+import time
 from pathlib import Path
 from tempfile import TemporaryDirectory
 from typing import Any
@@ -112,3 +113,17 @@ def rclone_execute(
                 tempdir.cleanup()
             except Exception as e:
                 print(f"Error cleaning up tempdir: {e}")
+
+
+def wait_for_mount(path: Path, mount_process: Any, timeout: int = 60) -> None:
+    from rclone_api.process import Process
+
+    assert isinstance(mount_process, Process)
+    expire_time = time.time() + timeout
+    while time.time() < expire_time:
+        rtn = mount_process.poll()
+        if rtn is not None:
+            raise subprocess.CalledProcessError(rtn, mount_process.cmd)
+        if path.exists():
+            return
+    raise TimeoutError(f"Path {path} did not exist after {timeout} seconds")

{rclone_api-1.0.21 → rclone_api-1.0.23}/src/rclone_api.egg-info/PKG-INFO

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

{rclone_api-1.0.21 → rclone_api-1.0.23}/src/rclone_api.egg-info/SOURCES.txt

@@ -38,9 +38,12 @@ src/rclone_api/walk.py
 src/rclone_api.egg-info/PKG-INFO
 src/rclone_api.egg-info/SOURCES.txt
 src/rclone_api.egg-info/dependency_links.txt
+src/rclone_api.egg-info/entry_points.txt
 src/rclone_api.egg-info/requires.txt
 src/rclone_api.egg-info/top_level.txt
 src/rclone_api/assets/example.txt
+src/rclone_api/cmd/list_files.py
+tests/test_cmd_list_files.py
 tests/test_copy.py
 tests/test_is_synced.py
 tests/test_ls.py

rclone_api-1.0.23/src/rclone_api.egg-info/entry_points.txt

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

rclone_api-1.0.23/tests/test_cmd_list_files.py

@@ -0,0 +1,83 @@
+"""
+Unit test file.
+"""
+
+import os
+import unittest
+
+from dotenv import load_dotenv
+
+from rclone_api import Config, Rclone, Remote
+from rclone_api.cmd.list_files import list_files
+
+load_dotenv()
+
+BUCKET_NAME = os.getenv("BUCKET_NAME")  # Default if not in .env
+
+
+def _generate_rclone_config() -> Config:
+
+    # BUCKET_NAME = os.getenv("BUCKET_NAME", "TorrentBooks")  # Default if not in .env
+
+    # Load additional environment variables
+    BUCKET_KEY_SECRET = os.getenv("BUCKET_KEY_SECRET")
+    BUCKET_KEY_PUBLIC = os.getenv("BUCKET_KEY_PUBLIC")
+    # BUCKET_URL = os.getenv("BUCKET_URL")
+    BUCKET_URL = "sfo3.digitaloceanspaces.com"
+
+    config_text = f"""
+[dst]
+type = s3
+provider = DigitalOcean
+access_key_id = {BUCKET_KEY_PUBLIC}
+secret_access_key = {BUCKET_KEY_SECRET}
+endpoint = {BUCKET_URL}
+bucket = {BUCKET_NAME}
+"""
+
+    out = Config(config_text)
+    return out
+
+
+class RcloneLsTests(unittest.TestCase):
+    """Test rclone functionality."""
+
+    def setUp(self) -> None:
+        """Check if all required environment variables are set before running tests."""
+        required_vars = [
+            "BUCKET_NAME",
+            "BUCKET_KEY_SECRET",
+            "BUCKET_KEY_PUBLIC",
+            "BUCKET_URL",
+        ]
+        missing = [var for var in required_vars if not os.getenv(var)]
+        if missing:
+            self.skipTest(
+                f"Missing required environment variables: {', '.join(missing)}"
+            )
+        os.environ["RCLONE_API_VERBOSE"] = "1"
+
+    def test_list_remotes(self) -> None:
+        rclone = Rclone(_generate_rclone_config())
+
+        remotes: list[Remote] = rclone.listremotes()
+        self.assertGreater(len(remotes), 0)
+        for remote in remotes:
+            self.assertIsInstance(remote, Remote)
+            print(remote)
+        print("done")
+
+    def test_cmd_list_files(self) -> None:
+        """Test listing the root directory of the bucket.
+
+        Verifies that we can:
+        1. Connect to the bucket
+        2. List its contents
+        3. Get both directories and files as proper types
+        """
+        rclone = Rclone(_generate_rclone_config())
+        list_files(rclone, f"dst:{BUCKET_NAME}")
+
+
+if __name__ == "__main__":
+    unittest.main()