tsync 0.1.0__tar.gz

tsync-0.1.0/.gitignore

@@ -0,0 +1,47 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Distribution
+*.tar.gz
+*.whl
+
+# Claude Code
+.claude/
+
+# Local notes
+TODO.md

tsync-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 jayghoshter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tsync-0.1.0/PKG-INFO

@@ -0,0 +1,236 @@
+Metadata-Version: 2.4
+Name: tsync
+Version: 0.1.0
+Summary: rsync wrapper to sync files between local machine and remotes with push/pull workflow
+Project-URL: Homepage, https://github.com/jayghoshter/tsync
+Project-URL: Repository, https://github.com/jayghoshter/tsync
+Author: jayghoshter
+License-Expression: MIT
+License-File: LICENSE
+Keywords: backup,remote,rsync,sync
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Archiving :: Mirroring
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: deepdiff>=6.0
+Requires-Dist: python-magic>=0.4
+Requires-Dist: rich>=13.0
+Requires-Dist: ruamel-yaml>=0.18
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# tsync
+
+An rsync wrapper for syncing entire or partial directory trees between machines
+with a simple push/pull workflow.
+
+> [!TIP]
+> `tsync` can be invoked from any nested subdirectory to synchronize the entire tree.
+
+> [!CAUTION]
+> This tool is tested for the authors workflow and has worked flawlessly for the
+> past several years. However, some caution is advised as this tool deals with
+> synchronizing files across devices. Please keep backups.
+
+> [!NOTE]
+> Feel free to request features or open bug tickets.
+
+## Features
+
+- **Push/Pull workflow**: Sync files to multiple remotes or pull from a single source
+- **Config-based remotes**: Define remotes once in `.tsync.yaml`, use by name
+- **Directory structure preservation**: Maintains relative paths from the config root
+- **Flexible excludes/includes**: Configure patterns in YAML or override via CLI
+- **Diff with remotes**: Compare local and remote states before syncing
+- **Remote command execution**: Run commands on remotes in the corresponding directory
+
+### Author's use case
+- Have a root directory filled with subdirectories for different simulations
+- Need to run simulations distributed across different machines
+- With the configs set up locally, 
+    - `tsync push server-1 -f dir01`, `tsync push server-2 -f dir02`, ...
+    - or from `dir01`, `tsync push server-1 -f .`
+- Run simulations on servers. It is now possible to use `tsync cmd ...` for remote execution
+- Run post processing on servers. `tsync cmd ...`
+- Only pull post-processed data to verify, `tsync pull server-1 -f dir01/post`, ...
+
+You may also set each simulation directory as a root with only one specific remote where it is to be executed.
+
+## Installation
+
+```bash
+pip install tsync
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install tsync    # install globally as a CLI tool
+uvx tsync                 # run without installing
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/jayghoshter/tsync.git
+cd tsync
+pip install -e .
+```
+
+## Quick Start
+
+1. Create a `.tsync.yaml` in your project root:
+
+```yaml
+remotes:
+    server: user@hostname:/path/to/backup
+    nas: nas:/volume1/projects  # if 'nas' is in ssh config
+    local_backup: /mnt/backup/projects
+
+excludes:
+    - __pycache__
+    - .git
+    - "*.pyc"
+    - node_modules
+
+includes:
+    - important.pyc  # override excludes for specific files
+```
+
+2. Push to a remote:
+
+```bash
+cd /path/to/project/subdir
+tsync push server
+```
+
+This syncs the current directory to `user@hostname:/path/to/backup/subdir/`.
+
+3. Pull from a remote:
+
+```bash
+tsync pull server
+```
+
+## Usage
+
+### Push
+
+Push current directory to one or more remotes:
+
+```bash
+tsync push server              # push to 'server'
+tsync push server nas          # push to multiple remotes
+tsync push all                 # push to all configured remotes
+tsync push server -f file.txt  # push specific files only
+```
+
+### Pull
+
+Pull from a remote to current directory:
+
+```bash
+tsync pull server
+tsync pull server -f file.txt  # pull specific files only
+```
+
+### Diff
+
+Compare local and remote states:
+
+```bash
+tsync diff server           # quick rsync-based diff
+tsync diff server --copy    # detailed diff with file contents
+```
+
+### Remote Commands
+
+Run commands on remotes in the corresponding directory:
+
+```bash
+tsync cmd --target server -- ls -la
+tsync cmd --target server -- git status
+```
+
+### Edit Config
+
+Open the nearest `.tsync.yaml` in your editor:
+
+```bash
+tsync edit
+```
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `-y, --no-confirm` | Don't prompt before syncing |
+| `-d, --dry-run` | Show what would be synced without doing it |
+| `-m, --mkdir` | Create remote directories before syncing |
+| `--delete` | Delete extraneous files on receiver |
+| `--delete-excluded` | Also delete excluded files on receiver |
+| `-ne, --no-excludes` | Ignore all exclude patterns |
+| `-e, --excludes` | Additional exclude patterns |
+| `-i, --includes` | Additional include patterns |
+| `-f, --files` | Specific files/directories to sync |
+
+Additional rsync options can be passed directly:
+
+```bash
+tsync push server -- --compress-level=9
+```
+
+## Configuration
+
+The `.tsync.yaml` file is searched upward from the current directory. The directory containing the config file is considered the "root" - all relative paths are computed from there.
+
+```yaml
+remotes:
+    # SSH remotes (rsync over SSH)
+    server: user@host:/path/to/root
+    shortname: hostname:/path/to/root  # uses ssh config
+
+    # Local paths
+    backup: /mnt/external/backup
+
+excludes:
+    - __pycache__
+    - "*.pyc"
+    - .git
+    - .env
+    - node_modules
+
+includes:
+    - .env.example  # include despite .env exclude pattern
+```
+
+## How It Works
+
+1. Searches upward for `.tsync.yaml` to find the project root
+2. Computes the relative path from root to current directory
+3. Constructs the remote path: `<remote_root>/<relative_path>/`
+4. Runs rsync with the configured options
+
+This means if you're in `/home/user/projects/myapp/src/` and the `.tsync.yaml` is in `/home/user/projects/myapp/`, syncing to `server: host:/backup` will target `host:/backup/src/`.
+
+## Requirements
+
+- Python 3.10+
+- rsync (installed on both local and remote machines)
+- SSH access to remote machines (for SSH remotes)
+
+## License
+
+MIT

tsync-0.1.0/README.md

@@ -0,0 +1,203 @@
+# tsync
+
+An rsync wrapper for syncing entire or partial directory trees between machines
+with a simple push/pull workflow.
+
+> [!TIP]
+> `tsync` can be invoked from any nested subdirectory to synchronize the entire tree.
+
+> [!CAUTION]
+> This tool is tested for the authors workflow and has worked flawlessly for the
+> past several years. However, some caution is advised as this tool deals with
+> synchronizing files across devices. Please keep backups.
+
+> [!NOTE]
+> Feel free to request features or open bug tickets.
+
+## Features
+
+- **Push/Pull workflow**: Sync files to multiple remotes or pull from a single source
+- **Config-based remotes**: Define remotes once in `.tsync.yaml`, use by name
+- **Directory structure preservation**: Maintains relative paths from the config root
+- **Flexible excludes/includes**: Configure patterns in YAML or override via CLI
+- **Diff with remotes**: Compare local and remote states before syncing
+- **Remote command execution**: Run commands on remotes in the corresponding directory
+
+### Author's use case
+- Have a root directory filled with subdirectories for different simulations
+- Need to run simulations distributed across different machines
+- With the configs set up locally, 
+    - `tsync push server-1 -f dir01`, `tsync push server-2 -f dir02`, ...
+    - or from `dir01`, `tsync push server-1 -f .`
+- Run simulations on servers. It is now possible to use `tsync cmd ...` for remote execution
+- Run post processing on servers. `tsync cmd ...`
+- Only pull post-processed data to verify, `tsync pull server-1 -f dir01/post`, ...
+
+You may also set each simulation directory as a root with only one specific remote where it is to be executed.
+
+## Installation
+
+```bash
+pip install tsync
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install tsync    # install globally as a CLI tool
+uvx tsync                 # run without installing
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/jayghoshter/tsync.git
+cd tsync
+pip install -e .
+```
+
+## Quick Start
+
+1. Create a `.tsync.yaml` in your project root:
+
+```yaml
+remotes:
+    server: user@hostname:/path/to/backup
+    nas: nas:/volume1/projects  # if 'nas' is in ssh config
+    local_backup: /mnt/backup/projects
+
+excludes:
+    - __pycache__
+    - .git
+    - "*.pyc"
+    - node_modules
+
+includes:
+    - important.pyc  # override excludes for specific files
+```
+
+2. Push to a remote:
+
+```bash
+cd /path/to/project/subdir
+tsync push server
+```
+
+This syncs the current directory to `user@hostname:/path/to/backup/subdir/`.
+
+3. Pull from a remote:
+
+```bash
+tsync pull server
+```
+
+## Usage
+
+### Push
+
+Push current directory to one or more remotes:
+
+```bash
+tsync push server              # push to 'server'
+tsync push server nas          # push to multiple remotes
+tsync push all                 # push to all configured remotes
+tsync push server -f file.txt  # push specific files only
+```
+
+### Pull
+
+Pull from a remote to current directory:
+
+```bash
+tsync pull server
+tsync pull server -f file.txt  # pull specific files only
+```
+
+### Diff
+
+Compare local and remote states:
+
+```bash
+tsync diff server           # quick rsync-based diff
+tsync diff server --copy    # detailed diff with file contents
+```
+
+### Remote Commands
+
+Run commands on remotes in the corresponding directory:
+
+```bash
+tsync cmd --target server -- ls -la
+tsync cmd --target server -- git status
+```
+
+### Edit Config
+
+Open the nearest `.tsync.yaml` in your editor:
+
+```bash
+tsync edit
+```
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `-y, --no-confirm` | Don't prompt before syncing |
+| `-d, --dry-run` | Show what would be synced without doing it |
+| `-m, --mkdir` | Create remote directories before syncing |
+| `--delete` | Delete extraneous files on receiver |
+| `--delete-excluded` | Also delete excluded files on receiver |
+| `-ne, --no-excludes` | Ignore all exclude patterns |
+| `-e, --excludes` | Additional exclude patterns |
+| `-i, --includes` | Additional include patterns |
+| `-f, --files` | Specific files/directories to sync |
+
+Additional rsync options can be passed directly:
+
+```bash
+tsync push server -- --compress-level=9
+```
+
+## Configuration
+
+The `.tsync.yaml` file is searched upward from the current directory. The directory containing the config file is considered the "root" - all relative paths are computed from there.
+
+```yaml
+remotes:
+    # SSH remotes (rsync over SSH)
+    server: user@host:/path/to/root
+    shortname: hostname:/path/to/root  # uses ssh config
+
+    # Local paths
+    backup: /mnt/external/backup
+
+excludes:
+    - __pycache__
+    - "*.pyc"
+    - .git
+    - .env
+    - node_modules
+
+includes:
+    - .env.example  # include despite .env exclude pattern
+```
+
+## How It Works
+
+1. Searches upward for `.tsync.yaml` to find the project root
+2. Computes the relative path from root to current directory
+3. Constructs the remote path: `<remote_root>/<relative_path>/`
+4. Runs rsync with the configured options
+
+This means if you're in `/home/user/projects/myapp/src/` and the `.tsync.yaml` is in `/home/user/projects/myapp/`, syncing to `server: host:/backup` will target `host:/backup/src/`.
+
+## Requirements
+
+- Python 3.10+
+- rsync (installed on both local and remote machines)
+- SSH access to remote machines (for SSH remotes)
+
+## License
+
+MIT

tsync-0.1.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "tsync"
+version = "0.1.0"
+description = "rsync wrapper to sync files between local machine and remotes with push/pull workflow"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "jayghoshter" }
+]
+keywords = ["rsync", "sync", "backup", "remote"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: System :: Archiving :: Mirroring",
+    "Topic :: Utilities",
+]
+
+dependencies = [
+    "rich>=13.0",
+    "ruamel.yaml>=0.18",
+    "deepdiff>=6.0",
+    "python-magic>=0.4",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+]
+
+[project.scripts]
+tsync = "tsync.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/jayghoshter/tsync"
+Repository = "https://github.com/jayghoshter/tsync"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/tsync"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+markers = [
+    "integration: tests that require rsync and filesystem operations",
+]

tsync-0.1.0/src/tsync/__init__.py

@@ -0,0 +1,3 @@
+"""tsync: rsync wrapper for syncing files with push/pull workflow."""
+
+__version__ = "0.1.0"