rclone-api 1.5.20__py3-none-any.whl → 1.5.22__py3-none-any.whl

rclone_api/fs.py

@@ -89,6 +89,21 @@ class RealFS(FS):
 
 
 class RemoteFS(FS):
+
+    @staticmethod
+    def from_rclone_config(
+        src: str, rclone_conf: Path | Config | str | None
+    ) -> "RemoteFS":
+        if isinstance(rclone_conf, str):
+            rclone_conf = Config(text=rclone_conf)
+        if rclone_conf is None:
+            curr_dir = Path.cwd() / "rclone.conf"
+            if curr_dir.exists():
+                rclone_conf = curr_dir
+            else:
+                raise ValueError("rclone_conf not found")
+        return RemoteFS(rclone_conf, src)
+
     def __init__(self, rclone_conf: Path | Config, src: str) -> None:
         from rclone_api import HttpServer, Rclone
 
@@ -131,7 +146,10 @@ class RemoteFS(FS):
         return self.server.exists(path)
 
     def mkdir(self, path: str, parents=True, exist_ok=True) -> None:
-        raise NotImplementedError("RemoteFS does not support mkdir")
+        # Ignore mkdir for remote backend, it will be made when file is written.
+        import warnings
+        warnings.warn("mkdir is not supported for remote backend", stacklevel=2)
+        return None
 
     def is_dir(self, path: Path | str) -> bool:
         path = self._to_str(path)

{rclone_api-1.5.20.dist-info → rclone_api-1.5.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rclone_api
-Version: 1.5.20
+Version: 1.5.22
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 License: BSD 3-Clause License
@@ -43,6 +43,10 @@ This library was built out of necessity to transfer large amounts of AI training
 
 You can have [rclone](https://rclone.org/) in your path or else the api will download it.
 
+## VFS
+
+There is a virtual file system called `FSPath` which emulates common operators for `pathlib.Path`. You can get an instance of an `FSPath` from an `Rclone` instance using the `rclone.cwd("src:path/to")` function.
+
 # Install
 
 `pip install rclone-api`
@@ -103,6 +107,71 @@ def test_ls_glob_png(self) -> None:
 ```python
 
 from rclone_api import Rclone
+"""
+Rclone API - Python interface for the Rclone command-line tool.
+
+This package provides a high-level API for interacting with Rclone,
+allowing file operations across various cloud storage providers.
+The API wraps the rclone command-line tool, providing a Pythonic interface
+for common operations like copying, listing, and managing remote storage.
+"""
+
+# Import core components and utilities
+from datetime import datetime
+from pathlib import Path
+from typing import Generator
+
+# Import logging utilities
+from rclone_api import log
+
+# Import data structures and models
+from .completed_process import CompletedProcess
+from .config import Config, Parsed, Section  # Configuration handling
+from .diff import DiffItem, DiffOption, DiffType  # File comparison utilities
+from .dir import Dir  # Directory representation
+from .dir_listing import DirListing  # Directory contents representation
+from .file import File, FileItem  # File representation
+from .file_stream import FilesStream  # Streaming file listings
+from .filelist import FileList  # File list utilities
+from .fs import FSPath, RemoteFS  # Filesystem utilities
+from .http_server import HttpFetcher, HttpServer, Range  # HTTP serving capabilities
+
+# Import logging configuration utilities
+from .log import configure_logging, setup_default_logging
+from .mount import Mount  # Mount remote filesystems
+from .process import Process  # Process management
+from .remote import Remote  # Remote storage representation
+from .rpath import RPath  # Remote path utilities
+from .s3.types import MultiUploadResult  # S3-specific types
+from .types import (  # Common types
+    ListingOption,
+    Order,
+    PartInfo,
+    SizeResult,
+    SizeSuffix,
+)
+
+# Set up default logging configuration when the package is imported
+setup_default_logging()
+
+
+def rclone_verbose(val: bool | None) -> bool:
+    """
+    Get or set the global verbosity setting for rclone operations.
+
+    Controls whether rclone commands will produce detailed output.
+    When enabled, commands will show more information about their operation.
+
+    Args:
+        val: If provided, sets the verbosity level. If None, returns the current setting.
+
+    Returns:
+        The current verbosity setting after any change.
+    """
+    from rclone_api.rclone_impl import rclone_verbose as _rclone_verbose
+
+    return _rclone_verbose(val)
+
 
 class Rclone:
     """
@@ -160,6 +229,27 @@ class Rclone:
         """
         return self.impl.webgui(other_args=other_args)
 
+    def filesystem(self, src: str) -> RemoteFS:
+        """
+        Get a RealFS object for interacting with the local filesystem.
+
+        Returns:
+            RealFS object for local filesystem operations
+        """
+        return self.impl.filesystem(src=src)
+
+    def cwd(self, src: str) -> FSPath:
+        """
+        Get the local root path for a filesystem.
+
+        Args:
+            src: Source path for the filesystem
+
+        Returns:
+            FSPath object representing the root of the filesystem
+        """
+        return self.impl.cwd(src=src)
+
     def launch_server(
         self,
         addr: str,
@@ -882,7 +972,7 @@ class Rclone:
     def serve_http(
         self,
         src: str,
-        addr: str = "localhost:8080",
+        addr: str | None = None,
         other_args: list[str] | None = None,
     ) -> HttpServer:
         """
@@ -903,7 +993,9 @@ class Rclone:
         Returns:
             HttpServer object with methods for accessing the served content
         """
-        return self.impl.serve_http(src=src, addr=addr, other_args=other_args)
+        return self.impl.serve_http(
+            src=src, cache_mode="minimal", addr=addr, other_args=other_args
+        )
 
     def size_files(
         self,
@@ -953,6 +1045,43 @@ class Rclone:
             SizeSuffix object representing the file size, or Exception if an error occurred
         """
         return self.impl.size_file(src=src)
+
+
+# Export public API components
+__all__ = [
+    # Main classes
+    "Rclone",  # Primary interface
+    "File",  # File representation
+    "Config",  # Configuration handling
+    "Remote",  # Remote storage
+    "Dir",  # Directory representation
+    "RPath",  # Remote path utilities
+    "DirListing",  # Directory listing
+    "FileList",  # File list
+    "FileItem",  # File item
+    "Process",  # Process management
+    "DiffItem",  # Difference item
+    "DiffType",  # Difference type
+    # Functions
+    "rclone_verbose",  # Verbosity control
+    # Data classes and enums
+    "CompletedProcess",  # Process result
+    "DiffOption",  # Difference options
+    "ListingOption",  # Listing options
+    "Order",  # Sorting order
+    "SizeResult",  # Size result
+    "Parsed",  # Parsed configuration
+    "Section",  # Configuration section
+    "MultiUploadResult",  # S3 upload result
+    "SizeSuffix",  # Size with suffix
+    # Utilities
+    "configure_logging",  # Logging configuration
+    "log",  # Logging utilities
+    "HttpServer",  # HTTP server
+    "Range",  # HTTP range
+    "HttpFetcher",  # HTTP fetcher
+    "PartInfo",  # Part information for uploads
+]
 ```
 
 

{rclone_api-1.5.20.dist-info → rclone_api-1.5.22.dist-info}/RECORD

@@ -13,7 +13,7 @@ rclone_api/file_item.py,sha256=cH-AQYsxedhNPp4c8NHY1ad4Z7St4yf_VGbmiGD59no,1770
 rclone_api/file_part.py,sha256=i6ByS5_sae8Eba-4imBVTxd-xKC8ExWy7NR8QGr0ors,6155
 rclone_api/file_stream.py,sha256=_W3qnwCuigqA0hzXl2q5pAxSZDRaUSwet4BkT0lpnzs,1431
 rclone_api/filelist.py,sha256=xbiusvNgaB_b_kQOZoHMJJxn6TWGtPrWd2J042BI28o,767
-rclone_api/fs.py,sha256=17sBC6WMBrZ-daoVs-9fZMr7xjnw3TnyjXTxS5SPBv8,6269
+rclone_api/fs.py,sha256=1hdRw-7NQnWJSmq6U2d9p2S9UNcND3cJIlDIFfyhQ1o,6898
 rclone_api/group_files.py,sha256=H92xPW9lQnbNw5KbtZCl00bD6iRh9yRbCuxku4j_3dg,8036
 rclone_api/http_server.py,sha256=ZdL-rGaq0zIjcaIiRIbPBQ4OIWZ7dCu71aq0nRlKtY4,11686
 rclone_api/install.py,sha256=Xb1BRn8rQcSpSd4dzmvIOELP2zM2DytUeIZ6jzv738A,2893
@@ -54,9 +54,9 @@ rclone_api/s3/multipart/upload_parts_inline.py,sha256=V7syKjFyVIe4U9Ahl5XgqVTzt9
 rclone_api/s3/multipart/upload_parts_resumable.py,sha256=6-nlMclS8jyVvMvFbQDcZOX9MY1WbCcKA_s9bwuYxnk,9793
 rclone_api/s3/multipart/upload_parts_server_side_merge.py,sha256=Fp2pdrs5dONQI9LkfNolgAGj1-Z2V1SsRd0r0sreuXI,18040
 rclone_api/s3/multipart/upload_state.py,sha256=f-Aq2NqtAaMUMhYitlICSNIxCKurWAl2gDEUVizLIqw,6019
-rclone_api-1.5.20.dist-info/licenses/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
-rclone_api-1.5.20.dist-info/METADATA,sha256=Y9h8Sh3rUSD4vDUIFG_itPAM7hw6SPfKhug8loC0D98,32696
-rclone_api-1.5.20.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-rclone_api-1.5.20.dist-info/entry_points.txt,sha256=fJteOlYVwgX3UbNuL9jJ0zUTuX2O79JFAeNgK7Sw7EQ,255
-rclone_api-1.5.20.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
-rclone_api-1.5.20.dist-info/RECORD,,
+rclone_api-1.5.22.dist-info/licenses/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
+rclone_api-1.5.22.dist-info/METADATA,sha256=9bBj235dgclFZikP1fwFFsVKrKz2yYqczJlBJoA4H-o,37155
+rclone_api-1.5.22.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+rclone_api-1.5.22.dist-info/entry_points.txt,sha256=fJteOlYVwgX3UbNuL9jJ0zUTuX2O79JFAeNgK7Sw7EQ,255
+rclone_api-1.5.22.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
+rclone_api-1.5.22.dist-info/RECORD,,