Metadata-Version: 2.4
Name: verisync
Version: 1.2.0
Summary: Interactive directory/file transfer with SHA-256 checksum verification over SSH
Project-URL: Homepage, https://github.com/whats2000/verisync
Project-URL: Repository, https://github.com/whats2000/verisync
Project-URL: Issues, https://github.com/whats2000/verisync/issues
Project-URL: Changelog, https://github.com/whats2000/verisync/blob/main/CHANGELOG.md
Author: whats2000
License: MIT License
        
        Copyright (c) 2026 whats2000
        
        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.
License-File: LICENSE
Keywords: checksum,file-transfer,hpc,rsync,sha256,ssh,verification
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: System :: Archiving :: Mirroring
Classifier: Topic :: System :: Networking
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# verisync — Interactive Directory Transfer with Checksum Verification

<div align="center">

[![PyPI version](https://badge.fury.io/py/verisync.svg)](https://badge.fury.io/py/verisync)
[![Python Versions](https://img.shields.io/pypi/pyversions/verisync)](https://pypi.org/project/verisync/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

**A general-purpose interactive file/directory transfer utility with end-to-end SHA-256 checksum verification over SSH.**  
Transfer files or directories to a remote server via rsync or tar.gz, then automatically verify every file's integrity — all from a single command.

</div>

---

## Table of Contents

- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
  - [Via pip (recommended)](#via-pip-recommended)
  - [Via pipx (isolated)](#via-pipx-isolated)
  - [Manual install](#manual-install)
- [Usage](#usage)
  - [Arguments](#arguments)
  - [Examples](#examples)
- [Transfer Steps](#transfer-steps)
- [Modes: rsync vs zip](#modes-rsync-vs-zip)
- [Contributing](#contributing)
- [License](#license)

---

## Features

- 📁 **File and directory** — transfer a single file or an entire directory tree
- ✅ **End-to-end SHA-256 verification** — a checksum manifest is generated locally and re-verified remotely after transfer
- ♻️ **rsync mode** (default) — incremental, resumable, and bandwidth-efficient
- 🗜️ **Zip mode** (`--zip`) — packs source into a `.tar.gz`, uploads, and auto-extracts on the remote
- 🔌 **SSH multiplexing** — a single SSH control socket is reused across all remote operations, including 2FA/password auth flows
- 📏 **Space checks** — remote free disk space is measured before transfer; warns if source exceeds 100 GiB
- 🖥️ **Interactive + CLI** — all parameters can be supplied as CLI flags or entered interactively at runtime
- 🕒 **Elapsed time** — reports total transfer and verification duration

---

## Requirements

| Requirement    | Notes                                                              |
| -------------- | ------------------------------------------------------------------ |
| **Bash >= 4.0** | Required for string manipulations and `set -euo pipefail`        |
| **rsync**      | Used for incremental file transfer in default mode                 |
| **ssh**        | SSH client with multiplexing (`ControlMaster`) support             |
| **sha256sum**  | Standard coreutils tool, available on all Linux/macOS systems      |
| **bc**         | Used for human-readable size arithmetic                            |
| **tar**        | Only required when using `--zip` mode                              |

> **Note:** `verisync` only needs to be installed on the **source machine**. The remote side requires only `sha256sum` and standard POSIX shell tools — no remote installation needed.

---

## Installation

### Via pip (recommended)

```bash
pip install verisync
```

This places the `verisync` command on your `PATH`.

### Via pipx (isolated)

```bash
pipx install verisync
```

### Manual install

```bash
git clone https://github.com/whats2000/verisync.git
cd verisync
bash verisync.sh --help
```

---

## Usage

```
verisync [OPTIONS]
```

### Arguments

| Flag                  | Description                                               |
| --------------------- | --------------------------------------------------------- |
| `-s, --src <path>`    | Local source file or directory to transfer                |
| `-u, --user <user>`   | Remote SSH username                                       |
| `-H, --host <host>`   | Remote SSH hostname or IP address                         |
| `-d, --dest <path>`   | Remote destination directory                              |
| `--zip`               | Pack source into `tar.gz` before transferring             |
| `-h, --help`          | Show usage and exit                                       |

Any flag not supplied on the command line will be prompted interactively.

### Examples

**Interactive mode** (prompts for all parameters):

```bash
verisync
```

**Fully specified via CLI**:

```bash
verisync --src /data/project --user alice --host hpc.example.com --dest /scratch/alice/
```

**Use zip mode for a single compressed upload**:

```bash
verisync -s /data/project -u alice -H hpc.example.com -d /scratch/alice/ --zip
```

---

## Transfer Steps

| Step | Description                                                                |
| ---- | -------------------------------------------------------------------------- |
| 1    | Collect source path, remote user, host, and destination                    |
| 2    | Measure local size; warn if > 100 GiB                                      |
| 3    | Test SSH connectivity; check remote free disk space                        |
| 4    | Generate SHA-256 checksum manifest for every file in the source            |
| 5    | Transfer files + manifest via rsync (or tar.gz); verify checksums remotely |

---

## Modes: rsync vs zip

| Feature             | rsync (default)         | `--zip` mode              |
| ------------------- | ----------------------- | ------------------------- |
| Resumable?          | Yes                     | No                        |
| Incremental?        | Yes                     | No                        |
| Single archive?     | No                      | Yes                       |
| Compression         | `-z` (inline)           | `gzip` (pre-compressed)   |
| Remote extraction   | Not needed              | Auto-extracted via `tar`  |

---

## Contributing

Bug reports and pull requests are welcome at [github.com/whats2000/verisync](https://github.com/whats2000/verisync).

---

## License

MIT — see [LICENSE](LICENSE) for details.