sshmirror 0.1.0__tar.gz

sshmirror-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+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.

sshmirror-0.1.0/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: sshmirror
+Version: 0.1.0
+Summary: SSH directory synchronization library and CLI
+Author: FellowCode
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/FellowCode/sshmirror
+Project-URL: Repository, https://github.com/FellowCode/sshmirror
+Project-URL: Issues, https://github.com/FellowCode/sshmirror/issues
+Keywords: ssh,sync,deployment,cli,remote-files,project-management
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Version Control
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiofiles
+Requires-Dist: aioshutil
+Requires-Dist: asyncssh
+Requires-Dist: beartype
+Requires-Dist: pydantic
+Requires-Dist: PyYAML
+Requires-Dist: questionary
+Requires-Dist: rich
+Dynamic: license-file
+
+# SSHMirror
+
+Sync a working directory with a remote server over SSH, inspect diffs before applying changes, and keep a lightweight local history for rollback-oriented workflows.
+
+SSHMirror is both:
+
+- a Python library you can import;
+- a CLI you can run inside a project folder;
+- a sync workflow that keeps local and remote changes inspectable.
+
+It can also be used as a lightweight sync workflow for a shared project: multiple developers can make changes to the same remote-backed codebase and inspect differences before pulling or pushing updates.
+
+## Why It Stands Out
+
+- Preview first. Inspect current file changes and version-to-version diffs before syncing. 🔍
+- Built for real SSH workflows. Passwords, SSH keys, passphrases, and ssh-agent fallback are supported. 🔐
+- Keeps local state. SSHMirror stores version and migration metadata under `.sshmirror/`. 🗂️
+- Works as a library or a command-line tool. 🐍
+- Useful for team workflows. Several developers can work on one project and sync changes through the same remote environment. 🤝
+- Optional remote container restart after sync. 🐳
+
+## Install 🚀
+
+```bash
+pip install sshmirror
+```
+
+For local development:
+
+```bash
+pip install -e .
+```
+
+## Quick Start ⚡
+
+1. Create a config file:
+
+   ```bash
+   sshmirror
+   ```
+
+   On first interactive launch, SSHMirror can create `sshmirror.config.yml` for you.
+
+2. Start from this minimal config:
+
+   ```yaml
+   host: '192.168.12.22'
+   port: '50022'
+   username: 'root'
+   localdir: '.'
+   remotedir: '/app'
+   author: your-name
+   ```
+
+3. Check status or connect-test before syncing:
+
+   ```bash
+   sshmirror --status
+   sshmirror --test-connection
+   ```
+
+## Example Configuration ⚙️
+
+The full example lives in [sshmirror.config.example.yml](sshmirror.config.example.yml).
+
+Supported auth patterns:
+
+- password auth;
+- private key auth;
+- private key with passphrase;
+- default SSH keys or ssh-agent when no key and no password are provided.
+
+Example with optional container restart:
+
+```yaml
+host: '192.168.12.22'
+port: '50022'
+username: 'root'
+localdir: '.'
+remotedir: '/app'
+author: your-name
+
+restart_container:
+   # Optional. If omitted, host/port/user are reused from the main SSH config.
+   # host: '192.168.12.22'
+   # port: '23322'
+   # user: user
+  sudo: true
+  container_name: testcontainer
+```
+
+`restart_container` connects to the Docker host where the container is running. If `host`, `port`, or `user` are not specified there, SSHMirror uses the main connection values.
+
+## CLI Commands 🧰
+
+```bash
+sshmirror --help
+```
+
+Main non-interactive flags:
+
+- `--status` show local and remote sync status;
+- `--current-diff` inspect current local versus remote differences;
+- `--version-diff` inspect changes between remote versions;
+- `--pull` only pull from remote;
+- `--stash-changes` stash local changes before syncing;
+- `--restore-stash` restore previously stashed changes;
+- `--force-pull` overwrite local files from remote;
+- `--discard` discard all local changes;
+- `--discard-files <paths...>` discard only selected files;
+- `--downgrade` downgrade remote version;
+- `--test-connection` validate SSH access to the remote host and configured Docker host.
+
+## Library Usage 📦
+
+```python
+from sshmirror import SSHMirror, SSHMirrorConfig
+
+mirror = SSHMirror(
+    config=SSHMirrorConfig(
+        host='127.0.0.1',
+        port=22,
+        username='root',
+        localdir='.',
+        remotedir='/app',
+    )
+)
+```
+
+The public API is exported from [sshmirror/__init__.py](sshmirror/__init__.py).
+
+## Project Layout
+
+```text
+sshmirror/
+  sshmirror/          # importable package
+  tests/              # smoke tests
+  pyproject.toml      # packaging metadata
+  sshmirror.config.example.yml
+```
+
+## Development 🛠️
+
+Run tests:
+
+```bash
+python -m unittest discover -s tests -p "test_*.py"
+```
+
+Build locally:
+
+```bash
+python -m build
+```
+
+## Status
+
+This repository is structured as a Python package with a CLI entry point. If you plan to publish to PyPI, keep package metadata, README, and license in sync with actual behavior.

sshmirror-0.1.0/README.md

@@ -0,0 +1,158 @@
+# SSHMirror
+
+Sync a working directory with a remote server over SSH, inspect diffs before applying changes, and keep a lightweight local history for rollback-oriented workflows.
+
+SSHMirror is both:
+
+- a Python library you can import;
+- a CLI you can run inside a project folder;
+- a sync workflow that keeps local and remote changes inspectable.
+
+It can also be used as a lightweight sync workflow for a shared project: multiple developers can make changes to the same remote-backed codebase and inspect differences before pulling or pushing updates.
+
+## Why It Stands Out
+
+- Preview first. Inspect current file changes and version-to-version diffs before syncing. 🔍
+- Built for real SSH workflows. Passwords, SSH keys, passphrases, and ssh-agent fallback are supported. 🔐
+- Keeps local state. SSHMirror stores version and migration metadata under `.sshmirror/`. 🗂️
+- Works as a library or a command-line tool. 🐍
+- Useful for team workflows. Several developers can work on one project and sync changes through the same remote environment. 🤝
+- Optional remote container restart after sync. 🐳
+
+## Install 🚀
+
+```bash
+pip install sshmirror
+```
+
+For local development:
+
+```bash
+pip install -e .
+```
+
+## Quick Start ⚡
+
+1. Create a config file:
+
+   ```bash
+   sshmirror
+   ```
+
+   On first interactive launch, SSHMirror can create `sshmirror.config.yml` for you.
+
+2. Start from this minimal config:
+
+   ```yaml
+   host: '192.168.12.22'
+   port: '50022'
+   username: 'root'
+   localdir: '.'
+   remotedir: '/app'
+   author: your-name
+   ```
+
+3. Check status or connect-test before syncing:
+
+   ```bash
+   sshmirror --status
+   sshmirror --test-connection
+   ```
+
+## Example Configuration ⚙️
+
+The full example lives in [sshmirror.config.example.yml](sshmirror.config.example.yml).
+
+Supported auth patterns:
+
+- password auth;
+- private key auth;
+- private key with passphrase;
+- default SSH keys or ssh-agent when no key and no password are provided.
+
+Example with optional container restart:
+
+```yaml
+host: '192.168.12.22'
+port: '50022'
+username: 'root'
+localdir: '.'
+remotedir: '/app'
+author: your-name
+
+restart_container:
+   # Optional. If omitted, host/port/user are reused from the main SSH config.
+   # host: '192.168.12.22'
+   # port: '23322'
+   # user: user
+  sudo: true
+  container_name: testcontainer
+```
+
+`restart_container` connects to the Docker host where the container is running. If `host`, `port`, or `user` are not specified there, SSHMirror uses the main connection values.
+
+## CLI Commands 🧰
+
+```bash
+sshmirror --help
+```
+
+Main non-interactive flags:
+
+- `--status` show local and remote sync status;
+- `--current-diff` inspect current local versus remote differences;
+- `--version-diff` inspect changes between remote versions;
+- `--pull` only pull from remote;
+- `--stash-changes` stash local changes before syncing;
+- `--restore-stash` restore previously stashed changes;
+- `--force-pull` overwrite local files from remote;
+- `--discard` discard all local changes;
+- `--discard-files <paths...>` discard only selected files;
+- `--downgrade` downgrade remote version;
+- `--test-connection` validate SSH access to the remote host and configured Docker host.
+
+## Library Usage 📦
+
+```python
+from sshmirror import SSHMirror, SSHMirrorConfig
+
+mirror = SSHMirror(
+    config=SSHMirrorConfig(
+        host='127.0.0.1',
+        port=22,
+        username='root',
+        localdir='.',
+        remotedir='/app',
+    )
+)
+```
+
+The public API is exported from [sshmirror/__init__.py](sshmirror/__init__.py).
+
+## Project Layout
+
+```text
+sshmirror/
+  sshmirror/          # importable package
+  tests/              # smoke tests
+  pyproject.toml      # packaging metadata
+  sshmirror.config.example.yml
+```
+
+## Development 🛠️
+
+Run tests:
+
+```bash
+python -m unittest discover -s tests -p "test_*.py"
+```
+
+Build locally:
+
+```bash
+python -m build
+```
+
+## Status
+
+This repository is structured as a Python package with a CLI entry point. If you plan to publish to PyPI, keep package metadata, README, and license in sync with actual behavior.

sshmirror-0.1.0/pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ['setuptools>=68', 'wheel']
+build-backend = 'setuptools.build_meta'
+
+[project]
+name = 'sshmirror'
+version = '0.1.0'
+description = 'SSH directory synchronization library and CLI'
+readme = 'README.md'
+requires-python = '>=3.11'
+license = 'MIT'
+authors = [
+    { name = 'FellowCode' },
+]
+keywords = ['ssh', 'sync', 'deployment', 'cli', 'remote-files', 'project-management']
+classifiers = [
+    'Development Status :: 3 - Alpha',
+    'Intended Audience :: Developers',
+    'Operating System :: OS Independent',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
+    'Programming Language :: Python :: 3.14',
+    'Topic :: Software Development :: Version Control',
+    'Topic :: System :: Networking',
+    'Topic :: Utilities',
+]
+dependencies = [
+    'aiofiles',
+    'aioshutil',
+    'asyncssh',
+    'beartype',
+    'pydantic',
+    'PyYAML',
+    'questionary',
+    'rich',
+]
+
+[project.urls]
+Homepage = 'https://github.com/FellowCode/sshmirror'
+Repository = 'https://github.com/FellowCode/sshmirror'
+Issues = 'https://github.com/FellowCode/sshmirror/issues'
+
+[project.scripts]
+sshmirror = 'sshmirror.cli:main'
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ['sshmirror', 'sshmirror.*']

sshmirror-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sshmirror-0.1.0/sshmirror/__init__.py

@@ -0,0 +1,14 @@
+from .config import SSHMirrorCallbacks, SSHMirrorConfig
+from .core.exceptions import ErrorLocalVersion, UserAbort, VersionAlreadyExists
+from .sshmirror import SSHMirror
+
+__all__ = [
+	'ErrorLocalVersion',
+	'SSHMirror',
+	'SSHMirrorCallbacks',
+	'SSHMirrorConfig',
+	'UserAbort',
+	'VersionAlreadyExists',
+]
+
+__version__ = '0.1.0'

sshmirror-0.1.0/sshmirror/__main__.py

@@ -0,0 +1,4 @@
+from .cli import main
+
+
+raise SystemExit(main())