easyclone 0.1.0__tar.gz → 0.3.0__tar.gz

{easyclone-0.1.0/src/easyclone.egg-info → easyclone-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: easyclone
-Version: 0.1.0
+Version: 0.3.0
 Summary: Very convenient Rclone bulk backup wrapper
 Project-URL: Repository, https://github.com/dybdeskarphet/easyclone
 Project-URL: Documentation, https://github.com/dybdeskarphet/easyclone
@@ -19,15 +19,28 @@ Dynamic: license-file
 
 You define what to back up, where to back it up, and EasyClone handles the syncs and copies — clean, fast, and reliable.
 
-## 🚀 Features
+## Features
 
-* 🔁 Sync & Copy support per-path
-* 📁 Backup multiple paths at once
-* 🧠 Human-friendly TOML config
-* 🛠️ IPC-ready architecture for future GUI or monitoring tools
-* 🔊 Optional verbose logging
+* Sync & Copy support per-path
+* Backup multiple paths at once
+* Human-friendly TOML config
+* IPC-ready architecture for future GUI or monitoring tools
+* Optional verbose logging
 
-## 🛠️ Requirements
+## Installation
+
+Install it with `pip` or `pipx`:
+
+```bash
+pip install easyclone
+pipx install easyclone
+```
+
+## Configuration
+
+The config file is at `~/.config/easyclone/config.toml` 
+
+## Requirements
 
 * Python **3.13+**
 * [`rclone`](https://rclone.org/) installed and accessible in your `$PATH`
@@ -35,7 +48,7 @@ You define what to back up, where to back it up, and EasyClone handles the syncs
 * `toml>=0.10.2`
 * `typer>=0.16.0`
 
-## 🧪 Example Usage
+## Example Usage
 
 ```bash
 easyclone start-backup
@@ -47,16 +60,16 @@ It will:
 * Copy the paths in `copy_paths`
 * Use the `remote_name` and `root_dir` to target your cloud storage
 
-## 🙋‍♀️ Contributing
+## Contributing
 
 PRs welcome. Bug reports even more welcome.
 
-## ❓ FAQ
+## FAQ
 
 Why does it create the folders first?
 > Because services like Google Drive support multiple folders with the same name in the same directory. So when you try to concurrently backup paths from the same directory, it will create the parent directory more than once, and we don't want that.
 
-## 📄 License
+## License
 
 GPLv3 — do whatever you want, just don't blame me if you sync your `/` folder to the cloud :)
 

{easyclone-0.1.0 → easyclone-0.3.0}/README.md

@@ -4,15 +4,28 @@
 
 You define what to back up, where to back it up, and EasyClone handles the syncs and copies — clean, fast, and reliable.
 
-## 🚀 Features
+## Features
 
-* 🔁 Sync & Copy support per-path
-* 📁 Backup multiple paths at once
-* 🧠 Human-friendly TOML config
-* 🛠️ IPC-ready architecture for future GUI or monitoring tools
-* 🔊 Optional verbose logging
+* Sync & Copy support per-path
+* Backup multiple paths at once
+* Human-friendly TOML config
+* IPC-ready architecture for future GUI or monitoring tools
+* Optional verbose logging
 
-## 🛠️ Requirements
+## Installation
+
+Install it with `pip` or `pipx`:
+
+```bash
+pip install easyclone
+pipx install easyclone
+```
+
+## Configuration
+
+The config file is at `~/.config/easyclone/config.toml` 
+
+## Requirements
 
 * Python **3.13+**
 * [`rclone`](https://rclone.org/) installed and accessible in your `$PATH`
@@ -20,7 +33,7 @@ You define what to back up, where to back it up, and EasyClone handles the syncs
 * `toml>=0.10.2`
 * `typer>=0.16.0`
 
-## 🧪 Example Usage
+## Example Usage
 
 ```bash
 easyclone start-backup
@@ -32,16 +45,16 @@ It will:
 * Copy the paths in `copy_paths`
 * Use the `remote_name` and `root_dir` to target your cloud storage
 
-## 🙋‍♀️ Contributing
+## Contributing
 
 PRs welcome. Bug reports even more welcome.
 
-## ❓ FAQ
+## FAQ
 
 Why does it create the folders first?
 > Because services like Google Drive support multiple folders with the same name in the same directory. So when you try to concurrently backup paths from the same directory, it will create the parent directory more than once, and we don't want that.
 
-## 📄 License
+## License
 
 GPLv3 — do whatever you want, just don't blame me if you sync your `/` folder to the cloud :)
 

{easyclone-0.1.0 → easyclone-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "easyclone"
-version = "0.1.0"
+version = "0.3.0"
 description = "Very convenient Rclone bulk backup wrapper"
 readme = "README.md"
 requires-python = ">=3.13"

{easyclone-0.1.0 → easyclone-0.3.0}/src/easyclone/config.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
+import json
 from threading import Lock
 from os import getenv
 from pathlib import Path
 from easyclone.utypes.enums import LogLevel
-from easyclone.utypes.config import BackupConfigModel, ConfigModel, RcloneConfigModel
+from easyclone.utypes.config import BackupConfigModel, ConfigModel
 import toml
 
 class Config:
@@ -31,21 +32,6 @@ class Config:
                 copy_paths=[],
                 remote_name="GoogleDrive",
                 root_dir="Backups/PC",
-                verbose_log=False
-            ),
-            rclone=RcloneConfigModel(
-                args=[
-                    "--update",
-                    "--verbose",
-                    "--transfers 30",
-                    "--checkers 8",
-                    "--contimeout 60s",
-                    "--timeout 300s",
-                    "--retries 3",
-                    "--low-level-retries 10",
-                    "--stats 1s"
-                ],
-                concurrent_limit=50
             )
         )
     
@@ -66,11 +52,14 @@ class Config:
     
         self._path = config_file
 
+    def _config_normalize(self, config: ConfigModel):
+        config.backup.root_dir = config.backup.root_dir.strip("/")
+        return config
+
     def _load_config(self):
         from easyclone.utils.essentials import log
         self._get_config_path()
 
-
         try:
             with open(self._path) as f:
                 parsed_string = f.read()
@@ -84,6 +73,7 @@ class Config:
         try:
             parsed_toml = toml.loads(parsed_string)
             validated_config = ConfigModel.model_validate(parsed_toml)
+            validated_config = self._config_normalize(validated_config)
             return validated_config
         except Exception as e:
             log(f"Invalid config: {e}", LogLevel.ERROR)

{easyclone-0.1.0 → easyclone-0.3.0}/src/easyclone/ipc/server.py

@@ -13,6 +13,7 @@ async def handle_client(_reader: asyncio.StreamReader, writer: asyncio.StreamWri
             message = json.dumps({
                 "total_path_count": await sync_status.get_total_path(),
                 "finished_path_count": await sync_status.get_currently_finished(),
+                "empty_paths": await sync_status.get_empty_paths(),
                 "operation_count": await sync_status.get_operation_count(),
                 "operations": await sync_status.get_operations()
             }).encode() + b"\n"

{easyclone-0.1.0 → easyclone-0.3.0}/src/easyclone/main.py

@@ -3,11 +3,12 @@ from typing import Annotated, Any
 from easyclone.config import cfg
 from easyclone.ipc.client import listen_ipc
 from easyclone.ipc.server import start_status_server
-from easyclone.rclone.operations import backup_copy_operation, backup_sync_operation
+from easyclone.rclone.operations import make_backup_operation
 import typer
 import json
-
 from easyclone.shared import sync_status
+from easyclone.utils.essentials import exit_if_currently_running, exit_if_no_rclone
+from easyclone.utypes.enums import CommandType
 
 app = typer.Typer(
     help="Very convenient Rclone bulk backup wrapper",
@@ -22,14 +23,16 @@ async def ipc():
 @app.command(help="Starts the backup process using the details in the config file.")
 def start_backup(verbose: Annotated[bool, typer.Option("--verbose", "-v", help="Enables the rclone logging (overrides config).")] = False):
     async def start():
+        exit_if_no_rclone() 
+        exit_if_currently_running() 
         await sync_status.set_total_path_count(len(cfg.backup.sync_paths) + len(cfg.backup.copy_paths))
 
         _ipc_task = asyncio.create_task(ipc()) 
 
         verbose_state = verbose or cfg.backup.verbose_log
 
-        await backup_copy_operation(verbose_state)
-        await backup_sync_operation(verbose_state)
+        await make_backup_operation(CommandType.COPY, cfg.backup.copy_paths, verbose_state)()
+        await make_backup_operation(CommandType.SYNC, cfg.backup.sync_paths, verbose_state)()
 
     asyncio.run(start())
 
@@ -38,11 +41,13 @@ def get_status(
         all: Annotated[bool, typer.Option("--all", "-a", help="Show all the backup status information.")] = False,
         show_total: Annotated[bool, typer.Option("--show-total", "-t", help="Show the total amount of paths.")] = False,
         show_current: Annotated[bool, typer.Option("--show-current", "-c", help="Show the total amount of pending paths.")] = False,
-        show_operations: Annotated[bool, typer.Option("--show-operations", "-o", help="Show currently running operations.")] = False
+        show_operations: Annotated[bool, typer.Option("--show-operations", "-o", help="Show currently running operations.")] = False,
+        show_operation_count: Annotated[bool, typer.Option("--get-operation-count", "-O", help="Show the total amount of running operations.")] = False,
+        show_empty_paths: Annotated[bool, typer.Option("--show-empty-paths", "-e", help="Show all the empty paths.")] = False
 ):
     data: Any = asyncio.run(listen_ipc())
 
-    if (not show_total and not show_current and not show_operations or all) or (show_total and show_current and show_operations):
+    if (not show_total and not show_current and not show_operations and not show_operation_count and not show_empty_paths or all) or (show_total and show_current and show_operations and show_operation_count and show_empty_paths):
         print(json.dumps(data, indent=2))
         return
 
@@ -55,5 +60,11 @@ def get_status(
     if show_operations:
         print(json.dumps(data["operations"], indent=2))
 
+    if show_operation_count:
+        print(json.dumps(data["operation_count"], indent=2))
+
+    if show_empty_paths:
+        print(json.dumps(data["empty_paths"], indent=2))
+
 if __name__ == "__main__":
     app()

{easyclone-0.1.0 → easyclone-0.3.0}/src/easyclone/rclone/__init__.py

@@ -1,3 +1,3 @@
 from .backup import backup
 from .create_dirs import create_dirs_array
-from .operations import backup_sync_operation, backup_copy_operation
+from .operations import make_backup_operation

{easyclone-0.1.0 → easyclone-0.3.0}/src/easyclone/rclone/backup.py

@@ -39,7 +39,6 @@ async def backup_command(rclone_command: list[str], source: str, dest: str, path
 async def backup(paths: list[PathItem], command_type: CommandType, rclone_args: list[str], semaphore: asyncio.Semaphore, verbose: bool = False):
     cmd = ["rclone", command_type.value]
 
-
     for arg in rclone_args:
         parts = shlex.split(arg)
         cmd += parts

{easyclone-0.1.0 → easyclone-0.3.0}/src/easyclone/rclone/create_dirs.py

@@ -56,7 +56,7 @@ def create_dirs_array(path_list: list[PathItem]):
     return only_dirs
 
 def create_dir_tree(path_list: list[PathItem]):
-    root = DirNode("Root", {"source": "/", "dest": f"{cfg.backup.remote_name}:{str(cfg.backup.root_dir).rstrip("/")}", "path_type": "dir",})
+    root = DirNode("Root", {"source": "/", "dest": f"{cfg.backup.remote_name}:{cfg.backup.root_dir}", "path_type": "dir",})
 
     for path_item in path_list:
         source_str = path_item.get("source")

easyclone-0.3.0/src/easyclone/rclone/operations.py

@@ -0,0 +1,35 @@
+import asyncio
+from easyclone.config import cfg
+from easyclone.rclone.backup import backup
+from easyclone.rclone.create_dirs import create_dir_tree, create_dirs_array, traverse_and_create_folders_by_depth
+from easyclone.shared import sync_status
+from easyclone.utils.essentials import log
+from easyclone.utils.path_manipulation import organize_paths
+from easyclone.utypes.enums import CommandType, LogLevel
+
+def make_backup_operation(command_type: CommandType, paths_config: list[str], verbose: bool):
+    async def backup_operation():
+        paths = organize_paths(paths_config, cfg.backup.remote_name)
+        task_semaphore = asyncio.Semaphore(cfg.rclone.concurrent_limit)
+        dirs_task_semaphore = asyncio.Semaphore(cfg.rclone.concurrent_limit)
+        dirs_array = create_dirs_array(paths["valid_paths"])
+        dirs_root = create_dir_tree(dirs_array)
+
+        log(f"Below paths couldn't be found:\n{"\n".join(paths["empty_paths"])}\n", LogLevel.WARN)
+        for path in paths["empty_paths"]:
+            await sync_status.add_empty_path(path)
+
+        _copy_folders_create_operation = await traverse_and_create_folders_by_depth(
+            root=dirs_root,
+            verbose=verbose,
+            semaphore=dirs_task_semaphore
+        )
+        _copy_operation = await backup(
+            paths=paths["valid_paths"],
+            command_type=command_type,
+            rclone_args=cfg.rclone.args,
+            semaphore=task_semaphore,
+            verbose=verbose
+        )
+
+    return backup_operation

{easyclone-0.1.0 → easyclone-0.3.0}/src/easyclone/shared/sync_status.py

@@ -7,8 +7,9 @@ class SyncStatus:
     def __init__(self):
         self.total_path_count: int = 0
         self.operations: list[SyncStatusItem]  = []
-        self.lock: asyncio.Lock = asyncio.Lock()
         self.finished_path_count: int = 0
+        self.empty_paths: list[str] = []
+        self.lock: asyncio.Lock = asyncio.Lock()
 
     async def add_operation(self, source: str, dest: str, path_type: str, status: BackupStatus, operation_type: RcloneOperationType):
         random_id = str(uuid.uuid4())
@@ -59,3 +60,11 @@ class SyncStatus:
     async def get_currently_finished(self):
         async with self.lock:
             return self.finished_path_count
+
+    async def add_empty_path(self, path: str):
+        async with self.lock:
+            self.empty_paths.append(path)
+
+    async def get_empty_paths(self):
+        async with self.lock:
+            return self.empty_paths

{easyclone-0.1.0 → easyclone-0.3.0}/src/easyclone/utils/__init__.py

@@ -1,2 +1,2 @@
-from .essentials import log
+from .essentials import log, exit_if_no_rclone
 from .path_manipulation import organize_paths, collapseuser

{easyclone-0.1.0 → easyclone-0.3.0}/src/easyclone/utils/essentials.py

@@ -1,3 +1,4 @@
+import os
 from easyclone.utypes.enums import LogLevel, BackupLog
 
 def log(message: str, logtype: LogLevel | BackupLog) -> None:
@@ -22,3 +23,17 @@ def log(message: str, logtype: LogLevel | BackupLog) -> None:
         full_msg = full_msg + ":"
 
     print(f"{full_msg}\033[0m {message}")
+
+def is_tool(name: str):
+    from shutil import which
+    return which(name) is not None
+
+def exit_if_no_rclone():
+    if not is_tool("rclone"):
+        log("Rclone is not installed on your system, 'rclone' command should be in the $PATH.", LogLevel.ERROR)
+        exit(1)
+
+def exit_if_currently_running():
+    if os.path.exists('/tmp/easyclone.sock'):
+        log("Easyclone is already running. Delete /tmp/easyclone.sock if you think this is a mistake.", LogLevel.WARN)
+        exit(1)

{easyclone-0.1.0 → easyclone-0.3.0}/src/easyclone/utils/path_manipulation.py

@@ -1,15 +1,20 @@
+import json
 from pathlib import Path
 import os
 from easyclone.utypes.enums import PathType
-from easyclone.utypes.models import PathItem
+from easyclone.utypes.models import OrganizedPaths, PathItem
 
-def organize_paths(paths: list[str], remote_name: str) -> list[PathItem]:
+def organize_paths(paths: list[str], remote_name: str) -> OrganizedPaths:
     from easyclone.config import cfg
     source_dest_array: list[PathItem] = []
+    empty_paths: list[str] = []
     root_dir = cfg.backup.root_dir
 
     for path in paths:
-        p = Path(path).expanduser()
+        p = Path(os.path.expandvars(os.path.expanduser(path)))
+
+        if not os.path.exists(p):
+            empty_paths.append(path)
 
         if p.is_dir():
             source_dest_array.append({
@@ -24,8 +29,11 @@ def organize_paths(paths: list[str], remote_name: str) -> list[PathItem]:
                 "dest": f"{remote_name}:{root_dir}{dest_dir}",
                 "path_type": PathType.FILE.value
             })
-
-    return source_dest_array
+    
+    return { 
+        "valid_paths": source_dest_array,
+        "empty_paths": empty_paths
+    }
 
 def collapseuser(path: str) -> str:
     """

easyclone-0.3.0/src/easyclone/utypes/config.py

@@ -0,0 +1,26 @@
+from pydantic import BaseModel
+
+class BackupConfigModel(BaseModel):
+    sync_paths: list[str]
+    copy_paths: list[str]
+    remote_name: str
+    root_dir: str
+    verbose_log: bool = False
+
+class RcloneConfigModel(BaseModel):
+    args: list[str] = [
+        "--update",
+        "--verbose",
+        "--transfers 30",
+        "--checkers 8",
+        "--contimeout 60s",
+        "--timeout 300s",
+        "--retries 3",
+        "--low-level-retries 10",
+        "--stats 1s"
+    ]
+    concurrent_limit: int = 50
+
+class ConfigModel(BaseModel):
+    backup: BackupConfigModel
+    rclone: RcloneConfigModel = RcloneConfigModel()

{easyclone-0.1.0 → easyclone-0.3.0}/src/easyclone/utypes/models.py

@@ -9,3 +9,8 @@ class SyncStatusItem(PathItem):
     id: str
     status: str
     operation_type: str
+
+class OrganizedPaths(TypedDict):
+    valid_paths: list[PathItem]
+    empty_paths: list[str]
+

{easyclone-0.1.0 → easyclone-0.3.0/src/easyclone.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: easyclone
-Version: 0.1.0
+Version: 0.3.0
 Summary: Very convenient Rclone bulk backup wrapper
 Project-URL: Repository, https://github.com/dybdeskarphet/easyclone
 Project-URL: Documentation, https://github.com/dybdeskarphet/easyclone
@@ -19,15 +19,28 @@ Dynamic: license-file
 
 You define what to back up, where to back it up, and EasyClone handles the syncs and copies — clean, fast, and reliable.
 
-## 🚀 Features
+## Features
 
-* 🔁 Sync & Copy support per-path
-* 📁 Backup multiple paths at once
-* 🧠 Human-friendly TOML config
-* 🛠️ IPC-ready architecture for future GUI or monitoring tools
-* 🔊 Optional verbose logging
+* Sync & Copy support per-path
+* Backup multiple paths at once
+* Human-friendly TOML config
+* IPC-ready architecture for future GUI or monitoring tools
+* Optional verbose logging
 
-## 🛠️ Requirements
+## Installation
+
+Install it with `pip` or `pipx`:
+
+```bash
+pip install easyclone
+pipx install easyclone
+```
+
+## Configuration
+
+The config file is at `~/.config/easyclone/config.toml` 
+
+## Requirements
 
 * Python **3.13+**
 * [`rclone`](https://rclone.org/) installed and accessible in your `$PATH`
@@ -35,7 +48,7 @@ You define what to back up, where to back it up, and EasyClone handles the syncs
 * `toml>=0.10.2`
 * `typer>=0.16.0`
 
-## 🧪 Example Usage
+## Example Usage
 
 ```bash
 easyclone start-backup
@@ -47,16 +60,16 @@ It will:
 * Copy the paths in `copy_paths`
 * Use the `remote_name` and `root_dir` to target your cloud storage
 
-## 🙋‍♀️ Contributing
+## Contributing
 
 PRs welcome. Bug reports even more welcome.
 
-## ❓ FAQ
+## FAQ
 
 Why does it create the folders first?
 > Because services like Google Drive support multiple folders with the same name in the same directory. So when you try to concurrently backup paths from the same directory, it will create the parent directory more than once, and we don't want that.
 
-## 📄 License
+## License
 
 GPLv3 — do whatever you want, just don't blame me if you sync your `/` folder to the cloud :)
 

easyclone-0.1.0/src/easyclone/rclone/operations.py

@@ -1,48 +0,0 @@
-import asyncio
-from easyclone.config import cfg
-from easyclone.rclone.backup import backup
-from easyclone.rclone.create_dirs import create_dir_tree, create_dirs_array, traverse_and_create_folders_by_depth
-from easyclone.utils.path_manipulation import organize_paths
-from easyclone.utypes.enums import CommandType
-
-async def backup_copy_operation(verbose: bool):
-    copy_paths = organize_paths(cfg.backup.copy_paths, cfg.backup.remote_name)
-    copy_task_semaphore = asyncio.Semaphore(cfg.rclone.concurrent_limit)
-    copy_dirs_task_semaphore = asyncio.Semaphore(cfg.rclone.concurrent_limit)
-    copy_dirs_array = create_dirs_array(copy_paths)
-    copy_dirs_root = create_dir_tree(copy_dirs_array)
-
-    _copy_folders_create_operation = await traverse_and_create_folders_by_depth(
-        root=copy_dirs_root,
-        verbose=verbose,
-        semaphore=copy_dirs_task_semaphore
-    )
-    _copy_operation = await backup(
-        paths=copy_paths,
-        command_type=CommandType.COPY,
-        rclone_args=cfg.rclone.args,
-        semaphore=copy_task_semaphore,
-        verbose=verbose
-    )
-
-
-async def backup_sync_operation(verbose: bool):
-    sync_paths = organize_paths(cfg.backup.sync_paths, cfg.backup.remote_name)
-    sync_task_semaphore = asyncio.Semaphore(cfg.rclone.concurrent_limit)
-    sync_dirs_task_semaphore = asyncio.Semaphore(cfg.rclone.concurrent_limit)
-    sync_dirs_array = create_dirs_array(sync_paths)
-    sync_dirs_root = create_dir_tree(sync_dirs_array)
-
-    _sync_folders_create_operation = await traverse_and_create_folders_by_depth(
-        root=sync_dirs_root,
-        verbose=verbose,
-        semaphore=sync_dirs_task_semaphore
-    )
-
-    _sync_operation = await backup(
-        paths=sync_paths,
-        command_type=CommandType.COPY,
-        rclone_args=cfg.rclone.args,
-        semaphore=sync_task_semaphore,
-        verbose=verbose
-    )

easyclone-0.1.0/src/easyclone/utypes/config.py

@@ -1,16 +0,0 @@
-from pydantic import BaseModel
-
-class BackupConfigModel(BaseModel):
-    sync_paths: list[str]
-    copy_paths: list[str]
-    remote_name: str
-    root_dir: str
-    verbose_log: bool
-
-class RcloneConfigModel(BaseModel):
-    args: list[str]
-    concurrent_limit: int
-
-class ConfigModel(BaseModel):
-    backup: BackupConfigModel
-    rclone: RcloneConfigModel