config : fix cache_dir_path value parsing error

Configparser's config.get returns a string and we want a Path. for the
moment convert it to Path directly.

README.md

@@ -1,6 +1,19 @@
 Unisync is a data synchronisation tool written in python and based on [unison](https://github.com/bcpierce00/unison).  
 I couldn't find a tool to fulfill the requirements I had for a synchronisation tool so I am creating my own as a wrapper around unison.  
 
+# Prerequisite
+
+You need to have the following tools installed.
+
+Locally :
+- unison
+- sshfs
+- nnn
+
+Remotely :
+- unison
+- cleanlinks and lndir (Should be in `xutils-dev` when using apt)
+
 # Goal
 
 Unisync purpose is to keep personal data synchronised between multiple machines without needing to have all the data present an all the machines at the same time. For example you might not need to have your movies on your laptop but still want them on your desktop at home or you might want to keep your old pictures only on a server.

pyproject.toml

@@ -10,6 +10,9 @@ requires-python = ">=3.13"
 dependencies = [
 ]
 
+[project.scripts]
+unisync = "unisync.main:main"
+
 [tool.poetry]
 packages = [{include = "unisync", from = "src"}]
 

src/unisync/argparser.py

@@ -1,22 +1,36 @@
-# Copyright (C) 2025 Paul Retourné
+# Copyright (C) 2025-2026 Paul Retourné
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 import argparse
 
-def create_argparser() -> argparse.ArgumentParser:
+def create_argparser(sync_function, add_function, mount_function) -> argparse.ArgumentParser:
+    """
+    Creates an argument parser to parse the command line arguments.
+    We use subparsers and set a default function for each to perform the correct action.
+    """
     parser = argparse.ArgumentParser(
             prog='unisync',
             description='File synchronisation application',
-            epilog="""
+            epilog="Copyright © 2025-2026 Paul Retourné.\n"
-            Copyright © 2025 Paul Retourné.
+            "License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.",
-            License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>."""
+            formatter_class=argparse.RawDescriptionHelpFormatter
             )
     parser.add_argument("local", nargs="?")
     parser.add_argument("remote", nargs="?")
+    parser.set_defaults(func=sync_function)
 
     remote_addr_group = parser.add_mutually_exclusive_group()
     remote_addr_group.add_argument("--ip")
     remote_addr_group.add_argument("--hostname")
 
     parser.add_argument("--config", help="Path to the configuration file", metavar="path_to_config")
+
+    subparsers = parser.add_subparsers(help='Actions other than synchronisation')
+
+    parser_add = subparsers.add_parser('add', help='Add files to be synchronised.')
+    parser_add.set_defaults(func=add_function)
+
+    parser_mount = subparsers.add_parser('mount', help='Mount the remote.')
+    parser_mount.set_defaults(func=mount_function)
+
     return parser

src/unisync/config.py

@@ -1,22 +1,24 @@
-# Copyright (C) 2025 Paul Retourné
+# Copyright (C) 2025-2026 Paul Retourné
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from configparser import UNNAMED_SECTION
 from dataclasses import dataclass, field
-from pathlib import Path, PosixPath
+from pathlib import Path
 import ipaddress
 import configparser
 
+from unisync.defaults import *
+
 @dataclass
 class ServerConfig:
     """
     Dataclass keeping the config for connecting to the server
     """
     user: str
-    sshargs: list[str] | None = field(default_factory=list)
+    sshargs: str
-    hostname: str = ""
+    hostname: str
-    ip: str = ""
+    ip: str
-    port: int = 22
+    port: int
 
     def __post_init__(self):
         """
@@ -44,15 +46,15 @@ class UnisonConfig:
     """
     Dataclass keeping unison specific configurations
     """
-    bools: list = field(default_factory=list)
+    bools: list
-    values: dict = field(default_factory=dict)
+    values: dict
 
 @dataclass
 class OtherConfig:
     """
     Dataclass keeping miscellanous configuration options
     """
-    cache_dir_path: PosixPath = Path("~/.unisync").expanduser()
+    cache_dir_path: Path
 
 @dataclass
 class Config:
@@ -62,7 +64,7 @@ class Config:
     server: ServerConfig
     roots: RootsConfig
     unison: UnisonConfig
-    other: OtherConfig = field(default_factory=OtherConfig)
+    other: OtherConfig
 
 
 def load_config(config_path:str) -> Config:
@@ -79,18 +81,22 @@ def load_config(config_path:str) -> Config:
     # Check if sections are provided
     server_section = "Server" if "Server" in config.sections() else UNNAMED_SECTION
     roots_section = "Roots" if "Roots" in config.sections() else UNNAMED_SECTION
+    other_section = "Other" if "Other" in config.sections() else UNNAMED_SECTION
 
     server_config = ServerConfig(
             config.get(server_section, "user"),
-            config.get(server_section, "sshargs", fallback=None),
+            config.get(server_section, "sshargs", fallback=DEFAULT_SERVER_SSHARGS),
-            config.get(server_section, "hostname", fallback=None),
+            config.get(server_section, "hostname", fallback=DEFAULT_SERVER_HOSTNAME),
-            config.get(server_section, "ip", fallback=None),
+            config.get(server_section, "ip", fallback=DEFAULT_SERVER_IP),
-            config.getint(server_section, "port", fallback=None)
+            config.getint(server_section, "port", fallback=DEFAULT_SERVER_PORT)
         )
     roots_config = RootsConfig(
-            config.get(roots_section, "local"),
+            config.get(roots_section, "local", fallback=DEFAULT_ROOTS_LOCAL),
             config.get(roots_section, "remote")
         )
+    other_config = OtherConfig(
+            Path(config.get(other_section, "cache_dir_path", fallback=DEFAULT_MISC_CACHE_DIR_PATH)).expanduser()
+        )
 
     args_bool = list()
     args_val = dict()
@@ -104,4 +110,4 @@ def load_config(config_path:str) -> Config:
                 args_val[key] = val
     unison_config = UnisonConfig(args_bool, args_val)
 
-    return Config(server_config, roots_config, unison_config)
+    return Config(server_config, roots_config, unison_config, other_config)

src/unisync/defaults.py

@@ -0,0 +1,18 @@
+# copyright (c) 2026 paul retourné
+# spdx-license-identifier: gpl-3.0-or-later
+
+from pathlib import Path
+
+# Commented out values are part of the config but are required so there is no defaults.
+# This allows this file to be a list of all the config options.
+
+# DEFAULT_SERVER_USER: str = "" 
+DEFAULT_SERVER_SSHARGS: str = ""
+DEFAULT_SERVER_HOSTNAME: str = ""
+DEFAULT_SERVER_IP: str = ""
+DEFAULT_SERVER_PORT: int = 22
+
+DEFAULT_ROOTS_LOCAL: str = str(Path("~/files").expanduser())
+# DEFAULT_ROOTS_REMOTE: str = ""
+
+DEFAULT_MISC_CACHE_DIR_PATH: Path = Path("~/.unisync").expanduser()

src/unisync/errors.py

@@ -0,0 +1,8 @@
+# Copyright (C) 2025-2026 Paul Retourné
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+class RemoteMountedError(BaseException):
+    pass
+
+class InvalidMountError(BaseException):
+    pass

src/unisync/main.py

@@ -1,24 +1,32 @@
-# Copyright (C) 2025 Paul Retourné
+# Copyright (C) 2025-2026 Paul Retourné
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 import os
-from argparser import create_argparser
+from pathlib import Path
-from config import RootsConfig, ServerConfig, Config, load_config
+
-from synchroniser import Synchroniser
+from unisync.argparser import create_argparser
+from unisync.runners import unisync_sync, unisync_add, unisync_mount
+from unisync.config import load_config
+from unisync.synchroniser import Synchroniser
+from unisync.paths import *
 
 def main():
-    parser = create_argparser()
+    parser = create_argparser(unisync_sync, unisync_add, unisync_mount)
-    base_namespace = parser.parse_args()
+    cli_args = parser.parse_args()
 
     config_path = os.path.expanduser("~/.config/unisync/config.ini")
-    if base_namespace.config != None and os.path.isfile(base_namespace.config):
+    # Check if --config is set
-        config = load_config(base_namespace.config)
+    if cli_args.config != None and os.path.isfile(cli_args.config):
+        config = load_config(cli_args.config)
     elif os.path.isfile(config_path):
         config = load_config(config_path)
     else:
-        # TODO make the command line arguments work and override the config options
+        # TODO replace the next line with something to do if no config file is found
+        config = load_config(config_path)
         pass
 
+    # TODO make the command line arguments work and override the config options
+
     synchroniser = Synchroniser(
             config.roots.remote,
             config.roots.local,
@@ -29,15 +37,9 @@ def main():
             config.unison.values
     )
 
-    if synchroniser.create_ssh_master_connection() != 0:
+    paths_manager = PathsManager(Path(config.roots.local), config.other.cache_dir_path)
-        print("Connection failed quitting")
-        return 1
-    print("Connected to the remote.")
-
-    synchroniser.sync_files(["salut"])
-
-    synchroniser.close_ssh_master_connection()
 
+    cli_args.func(synchroniser, paths_manager)
 
 
 if __name__ == "__main__":

src/unisync/paths.py

@@ -1,15 +1,16 @@
-# Copyright (C) 2025 Paul Retourné
+# Copyright (C) 2025-2026 Paul Retourné
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 
 import os.path
 import subprocess
+import sys
 
-from pathlib import Path, PosixPath
+from pathlib import Path
 
 class PathsManager:
 
-    def __init__(self, local_dir:PosixPath, cache_dir:PosixPath):
+    def __init__(self, local_dir:Path, cache_dir:Path):
         """
         Creates a PathsManager with the necessary data
         Args:
@@ -24,7 +25,7 @@ class PathsManager:
             raise ValueError("Invalid cache directory")
         self.cache_dir = cache_dir
 
-        self.paths_file:PosixPath = self.cache_dir / "paths"
+        self.paths_file:Path = self.cache_dir / "paths"
         if not self.paths_file.is_file():
             raise ValueError("The paths file does not exist")
 
@@ -48,7 +49,7 @@ class PathsManager:
                 "-p", "-",
                 self.local_dir
                 ]
-        nnn_process = subprocess.Popen(command, stdout=subprocess.PIPE)
+        nnn_process:subprocess.Popen = subprocess.Popen(command, stdout=subprocess.PIPE)
         try:
             ret_code = nnn_process.wait(timeout=choice_timeout)
         except subprocess.TimeoutExpired as e:
@@ -57,18 +58,18 @@ class PathsManager:
 
         if ret_code != 0:
             print("File selection failed", file=sys.stderr)
-            raise subprocess.CalledProcessError("File selection failed")
+            raise subprocess.CalledProcessError(1, "File selection failed")
 
         paths_list:list[str] = []
         while (next_path := nnn_process.stdout.readline()) != b'':
             next_path = next_path.decode().strip()
             # Make the path relative to the top directory
-            next_path = next_path[len(self.local_dir):].lstrip("/")
+            next_path = next_path[len(str(self.local_dir)):].lstrip("/")
             paths_list.append(next_path)
         return paths_list
 
     def add_files_to_sync(self):
-        while true:
+        while True:
             try:
                 paths = self.user_select_files()
                 break
@@ -105,7 +106,7 @@ class PathsManager:
             if not is_contained and new_path not in paths_to_add:
                 paths_to_add.append(new_path)
 
-        with self.paths_file.open("w") as f:
+        with self.paths_file.open("a") as f:
             for p in paths_to_add:
                 f.write(p + "\n")
 

src/unisync/runners.py

@@ -0,0 +1,36 @@
+# Copyright (C) 2025-2026 Paul Retourné
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from unisync.synchroniser import Synchroniser
+from unisync.paths import PathsManager
+
+
+def unisync_sync(synchroniser:Synchroniser, paths_manager:PathsManager):
+    if synchroniser.create_ssh_master_connection() != 0:
+        print("Connection failed quitting")
+        return 1
+    print("Connected to the remote.")
+
+    synchroniser.sync_files(paths_manager.get_paths_to_sync())
+    synchroniser.sync_links(paths_manager.get_paths_to_sync())
+    
+    # TODO check the config options and do or don't do the following
+    synchroniser.update_links()
+    #synchroniser.mount_remote_dir()
+
+    synchroniser.close_ssh_master_connection()
+
+
+def unisync_add(synchroniser:Synchroniser, paths_manager:PathsManager):
+    if synchroniser.create_ssh_master_connection() != 0:
+        print("Connection failed quitting")
+        return 1
+    print("Connected to the remote.")
+
+    paths_manager.add_files_to_sync()
+
+    synchroniser.close_ssh_master_connection()
+
+
+def unisync_mount(synchroniser:Synchroniser, paths_manager:PathsManager):
+    synchroniser.mount_remote_dir()

src/unisync/synchroniser.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2025 Paul Retourné
+# Copyright (C) 2025-2026 Paul Retourné
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 import subprocess
@@ -9,6 +9,8 @@ import logging
 
 from pathlib import Path
 
+from unisync.errors import RemoteMountedError, InvalidMountError
+
 logger = logging.getLogger(__name__)
 
 class Synchroniser:
@@ -175,16 +177,24 @@ class Synchroniser:
         Mount the remote directory to make the local links work.
         This is achieved using sshfs.
         Raise:
+        - RemoteMountedError: The .data directory is already a mount point
+        - InvalidMountError: .data is either not a directory or not empty
         - subprocess.CalledProcessError: An error occured with sshfs
         """
+        # Get the absolute path to the correct .data directory resolving symlinks
+        path_to_mount:Path = Path(f"{self.local}/../.data").resolve()
+        if path_to_mount.is_mount():
+            raise RemoteMountedError
+        # Check if it is an empty directory
+        if not path_to_mount.is_dir() or any(path_to_mount.iterdir()):
+            raise InvalidMountError
         command = [
                 "/usr/bin/sshfs",
                 "-o", "ControlPath={self.control_path}",
                 "-o", "ServerAliveInterval=15",
                 "-p", str(self.remote_port),
                 f"{self.remote_user}@{self.remote_ip}:{self.remote_dir}/.data",
-                # Get the absolute path to the correct .data directory resolving symlinks
+                str(path_to_mount)
-                str(Path(f"{self.local}/../.data").resolve())
                 ]
         completed_process = subprocess.run(command)
         completed_process.check_returncode()