rclone-api 1.4.33__py2.py3-none-any.whl → 1.5.1__py2.py3-none-any.whl

rclone_api/__init__.py

@@ -1,49 +1,105 @@
-# Import logging module to activate default configuration
+"""
+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
-from .diff import DiffItem, DiffOption, DiffType
-from .dir import Dir
-from .dir_listing import DirListing
-from .file import File, FileItem
-from .file_stream import FilesStream
-from .filelist import FileList
-from .http_server import HttpFetcher, HttpServer, Range
-
-# Import the configure_logging function to make it available at package level
+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 .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
-from .process import Process
-from .remote import Remote
-from .rpath import RPath
-from .s3.types import MultiUploadResult
-from .types import ListingOption, Order, PartInfo, SizeResult, SizeSuffix
-
+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:
+    """
+    Main interface for interacting with Rclone.
+
+    This class provides methods for all major Rclone operations including
+    file transfers, listing, mounting, and remote management.
+
+    It serves as the primary entry point for the API, wrapping the underlying
+    implementation details and providing a clean, consistent interface.
+    """
+
     def __init__(
         self, rclone_conf: Path | Config, rclone_exe: Path | None = None
     ) -> None:
+        """
+        Initialize the Rclone interface.
+
+        Args:
+            rclone_conf: Path to rclone config file or Config object
+            rclone_exe: Optional path to rclone executable. If None, will search in PATH.
+        """
         from rclone_api.rclone_impl import RcloneImpl
 
         self.impl: RcloneImpl = RcloneImpl(rclone_conf, rclone_exe)
 
     def webgui(self, other_args: list[str] | None = None) -> Process:
-        """Launch the Rclone web GUI."""
+        """
+        Launch the Rclone web GUI.
+
+        Starts the built-in web interface for interacting with rclone.
+
+        Args:
+            other_args: Additional command-line arguments to pass to rclone
+
+        Returns:
+            Process object representing the running web GUI
+        """
         return self.impl.webgui(other_args=other_args)
 
     def launch_server(
@@ -53,7 +109,20 @@ class Rclone:
         password: str | None = None,
         other_args: list[str] | None = None,
     ) -> Process:
-        """Launch the Rclone server so it can receive commands"""
+        """
+        Launch the Rclone server so it can receive commands.
+
+        Starts an rclone server that can be controlled remotely.
+
+        Args:
+            addr: Address and port to listen on (e.g., "localhost:5572")
+            user: Optional username for authentication
+            password: Optional password for authentication
+            other_args: Additional command-line arguments
+
+        Returns:
+            Process object representing the running server
+        """
         return self.impl.launch_server(
             addr=addr, user=user, password=password, other_args=other_args
         )
@@ -66,6 +135,19 @@ class Rclone:
         capture: bool | None = None,
         other_args: list[str] | None = None,
     ) -> CompletedProcess:
+        """
+        Send commands to a running rclone server.
+
+        Args:
+            addr: Address of the rclone server (e.g., "localhost:5572")
+            user: Optional username for authentication
+            password: Optional password for authentication
+            capture: Whether to capture and return command output
+            other_args: Additional command-line arguments
+
+        Returns:
+            CompletedProcess containing the command result
+        """
         return self.impl.remote_control(
             addr=addr,
             user=user,
@@ -75,7 +157,18 @@ class Rclone:
         )
 
     def obscure(self, password: str) -> str:
-        """Obscure a password for use in rclone config files."""
+        """
+        Obscure a password for use in rclone config files.
+
+        Converts a plaintext password to rclone's obscured format.
+        Note that this is not secure encryption, just light obfuscation.
+
+        Args:
+            password: The plaintext password to obscure
+
+        Returns:
+            The obscured password string
+        """
         return self.impl.obscure(password=password)
 
     def ls_stream(
@@ -85,31 +178,39 @@ class Rclone:
         fast_list: bool = False,
     ) -> FilesStream:
         """
-        List files in the given path
+        List files in the given path as a stream of results.
+
+        This method is memory-efficient for large directories as it yields
+        results incrementally rather than collecting them all at once.
 
         Args:
-            src: Remote path to list
+            path: Remote path to list
             max_depth: Maximum recursion depth (-1 for unlimited)
-            fast_list: Use fast list (only use when getting THE entire data repository from the root/bucket, or it's small)
+            fast_list: Use fast list (only recommended for listing entire repositories or small datasets)
+
+        Returns:
+            A stream of file entries that can be iterated over
         """
         return self.impl.ls_stream(path=path, max_depth=max_depth, fast_list=fast_list)
 
     def save_to_db(
         self,
         src: str,
-        db_url: str,
+        db_url: str,  # sqalchemy style url, use sqlite:///data.db or mysql://user:pass@localhost/db or postgres://user:pass@localhost/db
         max_depth: int = -1,
         fast_list: bool = False,
     ) -> None:
         """
-        Save files to a database (sqlite, mysql, postgres)
+        Save files to a database (sqlite, mysql, postgres).
+
+        Lists all files in the source path and stores their metadata in a database.
+        Useful for creating searchable indexes of remote storage.
 
         Args:
             src: Remote path to list, this will be used to populate an entire table, so always use the root-most path.
             db_url: Database URL, like sqlite:///data.db or mysql://user:pass@localhost/db or postgres://user:pass@localhost/db
             max_depth: Maximum depth to traverse (-1 for unlimited)
             fast_list: Use fast list (only use when getting THE entire data repository from the root/bucket)
-
         """
         return self.impl.save_to_db(
             src=src, db_url=db_url, max_depth=max_depth, fast_list=fast_list
@@ -123,6 +224,21 @@ class Rclone:
         order: Order = Order.NORMAL,
         listing_option: ListingOption = ListingOption.ALL,
     ) -> DirListing:
+        """
+        List files and directories at the specified path.
+
+        Provides a detailed listing with file metadata.
+
+        Args:
+            path: Path to list (Dir, Remote, or string path)
+            max_depth: Maximum recursion depth (None for default)
+            glob: Optional glob pattern to filter results
+            order: Sorting order for the results
+            listing_option: What types of entries to include
+
+        Returns:
+            DirListing object containing the results
+        """
         return self.impl.ls(
             path=path,
             max_depth=max_depth,
@@ -132,6 +248,14 @@ class Rclone:
         )
 
     def listremotes(self) -> list[Remote]:
+        """
+        List all configured remotes.
+
+        Returns a list of all remotes defined in the rclone configuration.
+
+        Returns:
+            List of Remote objects
+        """
         return self.impl.listremotes()
 
     def diff(
@@ -150,8 +274,26 @@ class Rclone:
         checkers: int | None = None,
         other_args: list[str] | None = None,
     ) -> Generator[DiffItem, None, None]:
-        """Be extra careful with the src and dst values. If you are off by one
-        parent directory, you will get a huge amount of false diffs."""
+        """
+        Compare two directories and yield differences.
+
+        Be extra careful with the src and dst values. If you are off by one
+        parent directory, you will get a huge amount of false diffs.
+
+        Args:
+            src: Rclone style src path
+            dst: Rclone style dst path
+            min_size: Minimum file size to check (e.g., "1MB")
+            max_size: Maximum file size to check (e.g., "1GB")
+            diff_option: How to report differences
+            fast_list: Whether to use fast listing
+            size_only: Compare only file sizes, not content
+            checkers: Number of checker threads
+            other_args: Additional command-line arguments
+
+        Yields:
+            DiffItem objects representing each difference found
+        """
         return self.impl.diff(
             src=src,
             dst=dst,
@@ -171,11 +313,17 @@ class Rclone:
         breadth_first: bool = True,
         order: Order = Order.NORMAL,
     ) -> Generator[DirListing, None, None]:
-        """Walk through the given path recursively.
+        """
+        Walk through the given path recursively, yielding directory listings.
+
+        Similar to os.walk(), but for remote storage. Traverses directories
+        and yields their contents.
 
         Args:
-            path: Remote path or Remote object to walk through
+            path: Remote path, Dir, or Remote object to walk through
             max_depth: Maximum depth to traverse (-1 for unlimited)
+            breadth_first: If True, use breadth-first traversal, otherwise depth-first
+            order: Sorting order for directory entries
 
         Yields:
             DirListing: Directory listing for each directory encountered
@@ -191,17 +339,20 @@ class Rclone:
         max_depth: int = -1,
         order: Order = Order.NORMAL,
     ) -> Generator[Dir, None, None]:
-        """Walk through the given path recursively.
+        """
+        Find folders that exist in source but are missing in destination.
 
-        WORK IN PROGRESS!!
+        Useful for identifying directories that need to be created before
+        copying files.
 
         Args:
-            src: Source directory or Remote to walk through
-            dst: Destination directory or Remote to walk through
+            src: Source directory or Remote to scan
+            dst: Destination directory or Remote to compare against
             max_depth: Maximum depth to traverse (-1 for unlimited)
+            order: Sorting order for directory entries
 
         Yields:
-            DirListing: Directory listing for each directory encountered
+            Dir: Each directory that exists in source but not in destination
         """
         return self.impl.scan_missing_folders(
             src=src, dst=dst, max_depth=max_depth, order=order
@@ -210,7 +361,18 @@ class Rclone:
     def cleanup(
         self, path: str, other_args: list[str] | None = None
     ) -> CompletedProcess:
-        """Cleanup any resources used by the Rclone instance."""
+        """
+        Cleanup any resources used by the Rclone instance.
+
+        Removes temporary files and directories created by rclone.
+
+        Args:
+            path: Path to clean up
+            other_args: Additional command-line arguments
+
+        Returns:
+            CompletedProcess with the result of the cleanup operation
+        """
         return self.impl.cleanup(path=path, other_args=other_args)
 
     def copy_to(
@@ -221,10 +383,21 @@ class Rclone:
         verbose: bool | None = None,
         other_args: list[str] | None = None,
     ) -> CompletedProcess:
-        """Copy one file from source to destination.
+        """
+        Copy one file from source to destination.
+
+        Warning - this can be slow for large files or when copying between
+        different storage providers.
 
-        Warning - slow.
+        Args:
+            src: Rclone style src path
+            dst: Rclone style dst path
+            check: Whether to verify the copy with checksums
+            verbose: Whether to show detailed progress
+            other_args: Additional command-line arguments
 
+        Returns:
+            CompletedProcess with the result of the copy operation
         """
         return self.impl.copy_to(
             src=src, dst=dst, check=check, verbose=verbose, other_args=other_args
@@ -249,10 +422,31 @@ class Rclone:
         multi_thread_streams: int | None = None,
         other_args: list[str] | None = None,
     ) -> list[CompletedProcess]:
-        """Copy multiple files from source to destination.
+        """
+        Copy multiple files from source to destination.
+
+        Efficiently copies a list of files, potentially in parallel.
 
         Args:
-            payload: Dictionary of source and destination file paths
+            src: Rclone style src path
+            dst: Rclone style dst path
+            files: List of file paths relative to src, or Path to a file containing the list
+            check: Whether to verify copies with checksums
+            max_backlog: Maximum number of queued transfers
+            verbose: Whether to show detailed progress
+            checkers: Number of checker threads
+            transfers: Number of file transfers to run in parallel
+            low_level_retries: Number of low-level retries
+            retries: Number of high-level retries
+            retries_sleep: Sleep interval between retries (e.g., "10s")
+            metadata: Whether to preserve metadata
+            timeout: IO idle timeout (e.g., "5m")
+            max_partition_workers: Maximum number of partition workers
+            multi_thread_streams: Number of streams for multi-thread copy
+            other_args: Additional command-line arguments
+
+        Returns:
+            List of CompletedProcess objects for each copy operation
         """
         return self.impl.copy_files(
             src=src,
@@ -285,11 +479,24 @@ class Rclone:
         retries: int | None = None,
         other_args: list[str] | None = None,
     ) -> CompletedProcess:
-        """Copy files from source to destination.
+        """
+        Copy files from source to destination.
+
+        Recursively copies all files from src to dst.
 
         Args:
-            src: Source directory
-            dst: Destination directory
+            src: Rclone style src path
+            dst: Rclone style dst path
+            check: Whether to verify copies with checksums
+            transfers: Number of file transfers to run in parallel
+            checkers: Number of checker threads
+            multi_thread_streams: Number of streams for multi-thread copy
+            low_level_retries: Number of low-level retries
+            retries: Number of high-level retries
+            other_args: Additional command-line arguments
+
+        Returns:
+            CompletedProcess with the result of the copy operation
         """
         return self.impl.copy(
             src=src,
@@ -304,7 +511,17 @@ class Rclone:
         )
 
     def purge(self, path: Dir | str) -> CompletedProcess:
-        """Purge a directory"""
+        """
+        Purge a directory.
+
+        Removes a directory and all its contents.
+
+        Args:
+            path: Rclone style path
+
+        Returns:
+            CompletedProcess with the result of the purge operation
+        """
         return self.impl.purge(path=path)
 
     def delete_files(
@@ -316,7 +533,20 @@ class Rclone:
         max_partition_workers: int | None = None,
         other_args: list[str] | None = None,
     ) -> CompletedProcess:
-        """Delete a directory"""
+        """
+        Delete files or directories.
+
+        Args:
+            files: Files to delete (single file/path or list)
+            check: Whether to verify deletions
+            rmdirs: Whether to remove empty directories
+            verbose: Whether to show detailed progress
+            max_partition_workers: Maximum number of partition workers
+            other_args: Additional command-line arguments
+
+        Returns:
+            CompletedProcess with the result of the delete operation
+        """
         return self.impl.delete_files(
             files=files,
             check=check,
@@ -327,19 +557,54 @@ class Rclone:
         )
 
     def exists(self, path: Dir | Remote | str | File) -> bool:
-        """Check if a file or directory exists."""
+        """
+        Check if a file or directory exists.
+
+        Args:
+            path: Path to check (Dir, Remote, File, or path string)
+
+        Returns:
+            True if the path exists, False otherwise
+        """
         return self.impl.exists(path=path)
 
     def is_synced(self, src: str | Dir, dst: str | Dir) -> bool:
-        """Check if two directories are in sync."""
+        """
+        Check if two directories are in sync.
+
+        Compares the contents of src and dst to determine if they match.
+
+        Args:
+            src: Source directory (Dir object or path string)
+            dst: Destination directory (Dir object or path string)
+
+        Returns:
+            True if the directories are in sync, False otherwise
+        """
         return self.impl.is_synced(src=src, dst=dst)
 
     def modtime(self, src: str) -> str | Exception:
-        """Get the modification time of a file or directory."""
+        """
+        Get the modification time of a file or directory.
+
+        Args:
+            src: Path to the file or directory
+
+        Returns:
+            Modification time as a string, or Exception if an error occurred
+        """
         return self.impl.modtime(src=src)
 
     def modtime_dt(self, src: str) -> datetime | Exception:
-        """Get the modification time of a file or directory."""
+        """
+        Get the modification time of a file or directory as a datetime object.
+
+        Args:
+            src: Path to the file or directory
+
+        Returns:
+            Modification time as a datetime object, or Exception if an error occurred
+        """
         return self.impl.modtime_dt(src=src)
 
     def write_text(
@@ -347,7 +612,18 @@ class Rclone:
         text: str,
         dst: str,
     ) -> Exception | None:
-        """Write text to a file."""
+        """
+        Write text to a file.
+
+        Creates or overwrites the file at dst with the given text.
+
+        Args:
+            text: Text content to write
+            dst: Destination file path
+
+        Returns:
+            None if successful, Exception if an error occurred
+        """
         return self.impl.write_text(text=text, dst=dst)
 
     def write_bytes(
@@ -355,15 +631,42 @@ class Rclone:
         data: bytes,
         dst: str,
     ) -> Exception | None:
-        """Write bytes to a file."""
+        """
+        Write bytes to a file.
+
+        Creates or overwrites the file at dst with the given binary data.
+
+        Args:
+            data: Binary content to write
+            dst: Destination file path
+
+        Returns:
+            None if successful, Exception if an error occurred
+        """
         return self.impl.write_bytes(data=data, dst=dst)
 
     def read_bytes(self, src: str) -> bytes | Exception:
-        """Read bytes from a file."""
+        """
+        Read bytes from a file.
+
+        Args:
+            src: Source file path
+
+        Returns:
+            File contents as bytes, or Exception if an error occurred
+        """
         return self.impl.read_bytes(src=src)
 
     def read_text(self, src: str) -> str | Exception:
-        """Read text from a file."""
+        """
+        Read text from a file.
+
+        Args:
+            src: Source file path
+
+        Returns:
+            File contents as a string, or Exception if an error occurred
+        """
         return self.impl.read_text(src=src)
 
     def copy_bytes(
@@ -374,7 +677,21 @@ class Rclone:
         outfile: Path,
         other_args: list[str] | None = None,
     ) -> Exception | None:
-        """Copy a slice of bytes from the src file to dst."""
+        """
+        Copy a slice of bytes from the src file to dst.
+
+        Extracts a portion of a file based on offset and length.
+
+        Args:
+            src: Source file path
+            offset: Starting position in the source file
+            length: Number of bytes to copy
+            outfile: Local file path to write the bytes to
+            other_args: Additional command-line arguments
+
+        Returns:
+            None if successful, Exception if an error occurred
+        """
         return self.impl.copy_bytes(
             src=src,
             offset=offset,
@@ -386,14 +703,38 @@ class Rclone:
     def copy_dir(
         self, src: str | Dir, dst: str | Dir, args: list[str] | None = None
     ) -> CompletedProcess:
-        """Copy a directory from source to destination."""
+        """
+        Copy a directory from source to destination.
+
+        Recursively copies all files and subdirectories.
+
+        Args:
+            src: Source directory (Dir object or path string)
+            dst: Destination directory (Dir object or path string)
+            args: Additional command-line arguments
+
+        Returns:
+            CompletedProcess with the result of the copy operation
+        """
         # convert src to str, also dst
         return self.impl.copy_dir(src=src, dst=dst, args=args)
 
     def copy_remote(
         self, src: Remote, dst: Remote, args: list[str] | None = None
     ) -> CompletedProcess:
-        """Copy a remote to another remote."""
+        """
+        Copy a remote to another remote.
+
+        Copies all contents from one remote storage to another.
+
+        Args:
+            src: Source remote
+            dst: Destination remote
+            args: Additional command-line arguments
+
+        Returns:
+            CompletedProcess with the result of the copy operation
+        """
         return self.impl.copy_remote(src=src, dst=dst, args=args)
 
     def copy_file_s3_resumable(
@@ -404,7 +745,25 @@ class Rclone:
         upload_threads: int = 8,  # Number of reader and writer threads to use
         merge_threads: int = 4,  # Number of threads to use for merging the parts
     ) -> Exception | None:
-        """Copy a file in parts."""
+        """
+        Copy a large file to S3 with resumable upload capability.
+
+        This method splits the file into parts for parallel upload and can
+        resume interrupted transfers using a custom algorithm in python.
+
+        Particularly useful for very large files where network interruptions
+        are likely.
+
+        Args:
+            src: Source file path (format: remote:bucket/path/file)
+            dst: Destination file path (format: remote:bucket/path/file)
+            part_infos: Optional list of part information for resuming uploads
+            upload_threads: Number of parallel upload threads
+            merge_threads: Number of threads for merging uploaded parts
+
+        Returns:
+            None if successful, Exception if an error occurred
+        """
         return self.impl.copy_file_s3_resumable(
             src=src,
             dst=dst,
@@ -426,17 +785,25 @@ class Rclone:
         log: Path | None = None,
         other_args: list[str] | None = None,
     ) -> Mount:
-        """Mount a remote or directory to a local path.
+        """
+        Mount a remote or directory to a local path.
+
+        Makes remote storage accessible as a local filesystem.
 
         Args:
             src: Remote or directory to mount
             outdir: Local path to mount to
+            allow_writes: Whether to allow write operations
+            use_links: Whether to use symbolic links
+            vfs_cache_mode: VFS cache mode (e.g., "full", "minimal")
+            verbose: Whether to show detailed output
+            cache_dir: Directory to use for caching
+            cache_dir_delete_on_exit: Whether to delete cache on exit
+            log: Path to write logs to
+            other_args: Additional command-line arguments
 
         Returns:
-            CompletedProcess from the mount command execution
-
-        Raises:
-            subprocess.CalledProcessError: If the mount operation fails
+            Mount object representing the mounted filesystem
         """
         return self.impl.mount(
             src=src,
@@ -457,12 +824,23 @@ class Rclone:
         addr: str = "localhost:8080",
         other_args: list[str] | None = None,
     ) -> HttpServer:
-        """Serve a remote or directory via HTTP. The returned HttpServer has a client which can be used to
-        fetch files or parts.
+        """
+        Serve a remote or directory via HTTP.
+
+        Creates an HTTP server that provides access to the specified remote.
+        The returned HttpServer object includes a client for fetching files.
+
+        This is useful for providing web access to remote storage or for
+        accessing remote files from applications that support HTTP but not
+        the remote's native protocol.
 
         Args:
             src: Remote or directory to serve
             addr: Network address and port to serve on (default: localhost:8080)
+            other_args: Additional arguments to pass to rclone
+
+        Returns:
+            HttpServer object with methods for accessing the served content
         """
         return self.impl.serve_http(src=src, addr=addr, other_args=other_args)
 
@@ -475,7 +853,25 @@ class Rclone:
         check: bool | None = False,
         verbose: bool | None = None,
     ) -> SizeResult | Exception:
-        """Get the size of a list of files. Example of files items: "remote:bucket/to/file"."""
+        """
+        Get the size of a list of files.
+
+        Calculates the total size of the specified files.
+
+        Args:
+            src: Base path for the files
+            files: List of file paths relative to src
+            fast_list: Whether to use fast listing (not recommended for accuracy)
+            other_args: Additional command-line arguments
+            check: Whether to verify file integrity
+            verbose: Whether to show detailed output
+
+        Returns:
+            SizeResult with size information, or Exception if an error occurred
+
+        Example:
+            size_files("remote:bucket", ["path/to/file1", "path/to/file2"])
+        """
         return self.impl.size_files(
             src=src,
             files=files,
@@ -486,38 +882,50 @@ class Rclone:
         )
 
     def size_file(self, src: str) -> SizeSuffix | Exception:
-        """Get the size of a file."""
+        """
+        Get the size of a file.
+
+        Args:
+            src: Path to the file
+
+        Returns:
+            SizeSuffix object representing the file size, or Exception if an error occurred
+        """
         return self.impl.size_file(src=src)
 
 
+# Export public API components
 __all__ = [
-    "Rclone",
-    "File",
-    "Config",
-    "Remote",
-    "Dir",
-    "RPath",
-    "DirListing",
-    "FileList",
-    "FileItem",
-    "Process",
-    "DiffItem",
-    "DiffType",
-    "rclone_verbose",
-    "CompletedProcess",
-    "DiffOption",
-    "ListingOption",
-    "Order",
-    "ListingOption",
-    "SizeResult",
-    "Parsed",
-    "Section",
-    "MultiUploadResult",
-    "SizeSuffix",
-    "configure_logging",
-    "log",
-    "HttpServer",
-    "Range",
-    "HttpFetcher",
-    "PartInfo",
+    # 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
 ]