easyclone 0.2.0__tar.gz → 1.0.0__tar.gz

{easyclone-0.2.0/src/easyclone.egg-info → easyclone-1.0.0}/PKG-INFO

@@ -1,10 +1,15 @@
 Metadata-Version: 2.4
 Name: easyclone
-Version: 0.2.0
+Version: 1.0.0
 Summary: Very convenient Rclone bulk backup wrapper
+Author-email: Ahmet Arda Kavakcı <ahmetardakavakci@gmail.com>
+Maintainer-email: Ahmet Arda Kavakcı <ahmetardakavakci@gmail.com>
+License-Expression: GPL-3.0-or-later
 Project-URL: Repository, https://github.com/dybdeskarphet/easyclone
 Project-URL: Documentation, https://github.com/dybdeskarphet/easyclone
 Project-URL: Issues, https://github.com/dybdeskarphet/easyclone/issues
+Project-URL: Changelog, https://github.com/dybdeskarphet/easyclone/blob/main/CHANGELOG.md
+Keywords: backup,sync,google,drive,easyclone
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -19,13 +24,13 @@ 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
 
 ## Installation
 
@@ -36,7 +41,11 @@ pip install easyclone
 pipx install easyclone
 ```
 
-## 🛠️ Requirements
+## Configuration
+
+The config file is at `~/.config/easyclone/config.toml` 
+
+## Requirements
 
 * Python **3.13+**
 * [`rclone`](https://rclone.org/) installed and accessible in your `$PATH`
@@ -44,7 +53,7 @@ pipx install easyclone
 * `toml>=0.10.2`
 * `typer>=0.16.0`
 
-## 🧪 Example Usage
+## Example Usage
 
 ```bash
 easyclone start-backup
@@ -56,16 +65,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.2.0 → easyclone-1.0.0}/README.md

@@ -4,13 +4,13 @@
 
 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
 
 ## Installation
 
@@ -21,7 +21,11 @@ pip install easyclone
 pipx install easyclone
 ```
 
-## 🛠️ Requirements
+## Configuration
+
+The config file is at `~/.config/easyclone/config.toml` 
+
+## Requirements
 
 * Python **3.13+**
 * [`rclone`](https://rclone.org/) installed and accessible in your `$PATH`
@@ -29,7 +33,7 @@ pipx install easyclone
 * `toml>=0.10.2`
 * `typer>=0.16.0`
 
-## 🧪 Example Usage
+## Example Usage
 
 ```bash
 easyclone start-backup
@@ -41,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.2.0 → easyclone-1.0.0}/pyproject.toml

@@ -1,8 +1,16 @@
 [project]
 name = "easyclone"
-version = "0.2.0"
+version = "1.0.0"
 description = "Very convenient Rclone bulk backup wrapper"
+keywords = ["backup", "sync", "google", "drive", "easyclone"]
+authors = [
+  {name = "Ahmet Arda Kavakcı", email = "ahmetardakavakci@gmail.com"},
+]
+maintainers = [
+  {name = "Ahmet Arda Kavakcı", email = "ahmetardakavakci@gmail.com"},
+]
 readme = "README.md"
+license = "GPL-3.0-or-later"
 requires-python = ">=3.13"
 dependencies = [
     "pydantic>=2.11.5",
@@ -17,6 +25,7 @@ easyclone = "easyclone.main:app"
 Repository = "https://github.com/dybdeskarphet/easyclone"
 Documentation = "https://github.com/dybdeskarphet/easyclone"
 Issues = "https://github.com/dybdeskarphet/easyclone/issues"
+Changelog = "https://github.com/dybdeskarphet/easyclone/blob/main/CHANGELOG.md"
 
 [tool.basedpyright]
 reportAny = false

{easyclone-0.2.0 → easyclone-1.0.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,6 +52,10 @@ 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()
@@ -83,10 +73,7 @@ class Config:
         try:
             parsed_toml = toml.loads(parsed_string)
             validated_config = ConfigModel.model_validate(parsed_toml)
-
-            # Normalize config
-            validated_config.backup.root_dir = validated_config.backup.root_dir.strip("/")
-
+            validated_config = self._config_normalize(validated_config)
             return validated_config
         except Exception as e:
             log(f"Invalid config: {e}", LogLevel.ERROR)

easyclone-1.0.0/src/easyclone/ipc/__init__.py

@@ -0,0 +1,2 @@
+from .server import start_status_server, SOCKET_PATH
+from .client import listen_ipc

easyclone-1.0.0/src/easyclone/main.py

@@ -0,0 +1,155 @@
+import asyncio
+import sys
+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 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",
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+async def ipc():
+    server = await start_status_server()
+    async with server:
+        await server.serve_forever()
+
+
+@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,
+):
+
+    import atexit
+    from os import path, remove
+    import signal
+    from types import FrameType
+    from easyclone.ipc.client import SOCKET_PATH
+    from easyclone.utils.essentials import log
+    from easyclone.utypes.enums import LogLevel
+
+    def cleanup():
+        if path.exists(SOCKET_PATH):
+            log("Cleaning up socket file...", LogLevel.WARN)
+            remove(SOCKET_PATH)
+
+    _ = atexit.register(cleanup)
+
+    def handle_signal(_signum: int, _frame: FrameType | None):
+        cleanup()
+        sys.exit(0)
+
+    _ = signal.signal(signal.SIGINT, handle_signal)
+    _ = signal.signal(signal.SIGTERM, handle_signal)
+
+    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 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())
+
+
+@app.command(help="Gets status information about the backup process.")
+def get_status(
+    all_args: 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_finished_path_count: Annotated[
+        bool,
+        typer.Option(
+            "--show-finished", "-f", help="Show the total amount of finished paths."
+        ),
+    ] = 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())
+
+    args = [
+        show_total,
+        show_current,
+        show_operations,
+        show_operation_count,
+        show_finished_path_count,
+        show_empty_paths,
+    ]
+
+    if not any(args) or all_args:
+        print(json.dumps(data, indent=2))
+        return
+
+    if show_total:
+        print(data["total_path_count"])
+
+    if show_current:
+        print(data["operation_count"])
+
+    if show_operations:
+        print(json.dumps(data["operations"], indent=2))
+
+    if show_operation_count:
+        print(data["operation_count"])
+
+    if show_finished_path_count:
+        print(data["finished_path_count"])
+
+    if show_empty_paths:
+        print(data["empty_paths"])
+
+
+if __name__ == "__main__":
+    app()

{easyclone-0.2.0 → easyclone-1.0.0}/src/easyclone/utils/path_manipulation.py

@@ -1,3 +1,4 @@
+import json
 from pathlib import Path
 import os
 from easyclone.utypes.enums import PathType
@@ -10,7 +11,7 @@ def organize_paths(paths: list[str], remote_name: str) -> OrganizedPaths:
     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)
@@ -28,7 +29,7 @@ def organize_paths(paths: list[str], remote_name: str) -> OrganizedPaths:
                 "dest": f"{remote_name}:{root_dir}{dest_dir}",
                 "path_type": PathType.FILE.value
             })
-
+    
     return { 
         "valid_paths": source_dest_array,
         "empty_paths": empty_paths

easyclone-1.0.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.2.0 → easyclone-1.0.0/src/easyclone.egg-info}/PKG-INFO

@@ -1,10 +1,15 @@
 Metadata-Version: 2.4
 Name: easyclone
-Version: 0.2.0
+Version: 1.0.0
 Summary: Very convenient Rclone bulk backup wrapper
+Author-email: Ahmet Arda Kavakcı <ahmetardakavakci@gmail.com>
+Maintainer-email: Ahmet Arda Kavakcı <ahmetardakavakci@gmail.com>
+License-Expression: GPL-3.0-or-later
 Project-URL: Repository, https://github.com/dybdeskarphet/easyclone
 Project-URL: Documentation, https://github.com/dybdeskarphet/easyclone
 Project-URL: Issues, https://github.com/dybdeskarphet/easyclone/issues
+Project-URL: Changelog, https://github.com/dybdeskarphet/easyclone/blob/main/CHANGELOG.md
+Keywords: backup,sync,google,drive,easyclone
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -19,13 +24,13 @@ 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
 
 ## Installation
 
@@ -36,7 +41,11 @@ pip install easyclone
 pipx install easyclone
 ```
 
-## 🛠️ Requirements
+## Configuration
+
+The config file is at `~/.config/easyclone/config.toml` 
+
+## Requirements
 
 * Python **3.13+**
 * [`rclone`](https://rclone.org/) installed and accessible in your `$PATH`
@@ -44,7 +53,7 @@ pipx install easyclone
 * `toml>=0.10.2`
 * `typer>=0.16.0`
 
-## 🧪 Example Usage
+## Example Usage
 
 ```bash
 easyclone start-backup
@@ -56,16 +65,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.2.0/src/easyclone/ipc/__init__.py

@@ -1,2 +0,0 @@
-from .server import start_status_server
-from .client import listen_ipc

easyclone-0.2.0/src/easyclone/main.py

@@ -1,70 +0,0 @@
-import asyncio
-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 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",
-    context_settings={"help_option_names": ["-h", "--help"]}
-)
-
-async def ipc():
-    server = await start_status_server()
-    async with server:
-        await server.serve_forever()
-
-@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 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())
-
-@app.command(help="Gets status information about the backup process.")
-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_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 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
-
-    if show_total:
-        print(data["total_path_count"])
-
-    if show_current:
-        print(data["operation_count"])
-
-    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.2.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