vaayu 0.1.0__tar.gz

vaayu-0.1.0/LICENSE

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

vaayu-0.1.0/PKG-INFO

@@ -0,0 +1,386 @@
+Metadata-Version: 2.4
+Name: vaayu
+Version: 0.1.0
+Summary: A modern, secure, parallel, and resumable SSH file transfer CLI (scp/rsync replacement).
+Author: Eshan Singh
+Maintainer: Eshan Singh
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/R0X4R/vaayu
+Project-URL: Bug Reports, https://github.com/R0X4R/vaayu/issues
+Project-URL: Source, https://github.com/R0X4R/vaayu
+Project-URL: Documentation, https://github.com/R0X4R/vaayu#readme
+Keywords: ssh,sftp,file transfer,resumable,async,zstd,cli
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: Utilities
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: asyncssh>=2.14.2
+Requires-Dist: zstandard>=0.22.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: watchdog>=4.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: mypy>=1.10.0; extra == "dev"
+Requires-Dist: ruff>=0.5.0; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+![thumbnail](https://github.com/R0X4R/vaayu/blob/main/.github/thumbnail.png?raw=true)
+
+
+**Modern • Secure • Parallel • Resumable**
+
+[![Python 3.9+](https://img.shields.io/badge/Python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![SSH/SFTP](https://img.shields.io/badge/Protocol-SSH%2FSFTP-orange.svg)](https://www.openssh.com/)
+
+Vaayu is the next-generation SSH file transfer tool that moves your data like air - fast, light, and omnipresent.
+
+</div>
+
+---
+
+## ✨ Why Vaayu?
+
+**Vaayu** (Sanskrit: वायु) means "air"—the element that flows everywhere with speed and grace. Just as air adapts to any environment while maintaining its essential properties, Vaayu delivers files across networks with uncompromising reliability and performance.
+
+### 🚀 Core Capabilities
+
+| Feature | Description |
+|---------|-------------|
+| **🔒 Secure by Design** | Modern SSH ciphers (ChaCha20-Poly1305, AES-256-GCM) with optional strict host key verification |
+| **⚡ Lightning Fast** | Parallel transfers with intelligent concurrency auto-tuning |
+| **🔄 Bulletproof Resume** | Atomic writes with `.part` files and intelligent offset recovery |
+| **🛡️ Data Integrity** | SHA-256 verification with robust remote fallback chains |
+| **🎯 Smart Operations** | Recursive directory sync, wildcard matching, and real-time progress |
+| **👁️ Live Monitoring** | Watch mode for continuous synchronization |
+| **🌐 Universal** | Windows, macOS, Linux (Python 3.9+) |
+
+### 📡 Transfer Modes
+
+- **📤 Send** — Local → Remote with recursive directory support
+- **📥 Get** — Remote → Local with wildcard expansion
+- **🔄 Relay** — Remote → Remote without local download
+
+
+## 🏗️ Architecture
+
+Built on enterprise-grade foundations:
+
+- **AsyncIO + AsyncSSH** — High-performance asynchronous I/O
+- **Rich Progress** — Beautiful terminal UI with real-time metrics
+- **Watchdog** — Filesystem monitoring for live sync
+- **zstd** — Optional compression pipeline (future enhancement)
+
+
+## 🚀 Quick Start
+
+### Installation
+
+**Windows (PowerShell)**
+```powershell
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+pip install -e .
+```
+
+**macOS/Linux (Bash)**
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e .
+```
+
+### Verify Installation
+```bash
+vaayu --help
+```
+
+
+## 📚 Command Reference
+
+### Global Options
+
+| Short | Long | Description |
+|-------|------|-------------|
+| `-h` | `--help` | Show help message |
+| `-p` | `--port` | SSH port (default: 22) |
+| `-u` | `--username` | SSH username |
+| `-P` | `--password` | SSH password |
+| `-i` | `--identity` | Path to private key |
+| `-j` | `--parallel` | Parallel transfer jobs |
+| `-r` | `--retries` | Max retries per file (default: 5) |
+| `-b` | `--backoff` | Initial backoff seconds (default: 0.5) |
+| `-c` | `--compress` | Enable compression |
+| `-z` | `--zstd-level` | Compression level (default: 3) |
+| `-k` | `--verify-host-key` | Strict host key verification |
+| `-n` | `--no-verify` | Skip hash verification |
+
+### Commands
+
+| Command | Description |
+|---------|-------------|
+| `send` | Transfer files from local to remote |
+| `get` | Transfer files from remote to local |
+| `relay` | Transfer files between two remote hosts |
+
+
+## 💼 Usage Examples
+
+### 📤 Send Operations
+
+**Basic File Upload**
+```bash
+vaayu -u alice -i ~/.ssh/id_ed25519 send alice@server.com /remote/backup file.txt
+```
+
+**Recursive Directory Upload**
+```bash
+vaayu -u alice -i ~/.ssh/id_ed25519 send alice@server.com /remote/backup /local/project/
+```
+
+**Wildcard Upload with High Parallelism**
+```bash
+vaayu -u alice -i ~/.ssh/id_ed25519 -j 16 send alice@server.com /remote/logs *.log
+```
+
+**Password Authentication**
+```bash
+vaayu -u alice -P mypassword send alice@server.com /remote/backup document.pdf
+```
+
+**Custom Port and Strict Host Key Verification**
+```bash
+vaayu -u alice -p 2222 -k -i ~/.ssh/id_ed25519 send alice@server.com /backup file.txt
+```
+
+**Multiple Files and Directories**
+```bash
+vaayu -u alice -i ~/.ssh/id_ed25519 send alice@server.com /backup file1.txt dir1/ *.csv
+```
+
+**Live Watch Mode**
+```bash
+vaayu -u alice -i ~/.ssh/id_ed25519 send alice@server.com /remote/www /local/website/ -W
+```
+
+### 📥 Get Operations
+
+**Basic File Download**
+```bash
+vaayu -u bob -i ~/.ssh/id_ed25519 get bob@server.com /local/downloads /remote/file.txt
+```
+
+**Wildcard Download**
+```bash
+vaayu -u bob -i ~/.ssh/id_ed25519 get bob@server.com /local/logs /var/log/*.log
+```
+
+**Recursive Directory Download**
+```bash
+vaayu -u bob -i ~/.ssh/id_ed25519 get bob@server.com /local/backup /remote/project/
+```
+
+**Multiple Remote Paths**
+```bash
+vaayu -u bob -i ~/.ssh/id_ed25519 get bob@server.com /local/data /remote/file1.txt /remote/dir/ /remote/*.csv
+```
+
+**High Concurrency Download**
+```bash
+vaayu -u bob -i ~/.ssh/id_ed25519 -j 32 get bob@server.com /local/download /remote/bigdata/
+```
+
+### 🔄 Relay Operations
+
+**Direct Remote-to-Remote Transfer**
+```bash
+vaayu -u admin -i ~/.ssh/id_ed25519 relay admin@source.com admin@dest.com /data/file.txt /backup/file.txt
+```
+
+**Multiple File Relay**
+```bash
+vaayu -u admin -i ~/.ssh/id_ed25519 relay admin@source.com admin@dest.com /data/file1.txt /data/file2.txt /backup/file1.txt /backup/file2.txt
+```
+
+**Cross-Server Directory Sync**
+```bash
+vaayu -u admin -i ~/.ssh/id_ed25519 relay admin@prod.com admin@backup.com /var/www/ /backups/www/
+```
+
+### ⚙️ Advanced Usage
+
+**Resume Interrupted Transfer**
+```bash
+vaayu -u alice -i ~/.ssh/id_ed25519 send alice@server.com /remote/backup largefile.zip
+```
+
+**Skip Verification for Trusted Networks**
+```bash
+vaayu -u alice -i ~/.ssh/id_ed25519 -n send alice@server.com /remote/backup *.txt
+```
+
+**Custom Retry Strategy**
+```bash
+vaayu -u alice -i ~/.ssh/id_ed25519 -r 10 -b 1.0 send alice@server.com /backup file.txt
+```
+
+**Compression Enabled**
+```bash
+vaayu -u alice -i ~/.ssh/id_ed25519 -c -z 6 send alice@server.com /backup archive.tar
+```
+
+
+## 🔧 Performance Tuning
+
+### Parallelism Guidelines
+
+| File Count | Recommended `-j` | Use Case |
+|------------|------------------|----------|
+| 1-10 | 2-4 | Large files |
+| 10-100 | 4-8 | Mixed workload |
+| 100-1000 | 8-16 | Many small files |
+| 1000+ | 16-32 | Massive parallel I/O |
+
+### Network Optimization
+
+```bash
+vaayu -u user -j 8 -r 3 -b 0.2 send user@host /dest /large/dataset/
+```
+
+
+## 🛡️ Security Features
+
+### Authentication Methods
+
+- **SSH Key Authentication** (Recommended)
+- **Password Authentication**
+- **SSH Agent Support**
+
+### Encryption Standards
+
+- **ChaCha20-Poly1305@openssh.com** (Primary)
+- **AES-256-GCM@openssh.com** (Fallback)
+
+### Data Integrity
+
+- **SHA-256 Verification** (Default)
+- **Atomic Writes** (`.part` → rename)
+- **Multiple Remote Hash Sources**
+
+
+## 🏥 Error Handling & Recovery
+
+### Automatic Recovery Features
+
+- **Resume from Interruption** — Continues from last byte
+- **Exponential Backoff** — Smart retry timing
+- **Hash Verification** — Detects corruption
+- **Atomic Operations** — No partial writes
+
+### Common Issues & Solutions
+
+| Issue | Solution |
+|-------|----------|
+| Connection timeout | Increase `-r` retries and `-b` backoff |
+| Permission denied | Check SSH key permissions and remote path access |
+| Hash mismatch | Network corruption; transfer will auto-retry |
+| Host key verification failed | Use `-k` flag with proper known_hosts |
+
+
+## 🧪 Testing & Validation
+
+### Run Test Suite
+```bash
+pytest -q
+```
+
+### Feature Validation Commands
+
+**Resume Testing**
+```bash
+vaayu -u user send user@host /dest largefile.bin
+```
+
+**Verification Testing**
+```bash
+vaayu -u user send user@host /dest testfile.txt
+sha256sum testfile.txt
+ssh user@host "sha256sum /dest/testfile.txt"
+```
+
+**Performance Testing**
+```bash
+time vaayu -u user -j 16 send user@host /dest /large/dataset/
+```
+
+
+## 📊 Project Structure
+
+```
+vaayu/
+├── cli.py           # Command-line interface
+├── ssh_client.py    # AsyncSSH wrapper
+├── transfer.py      # Core transfer logic
+├── verify.py        # Hash verification
+├── utils.py         # Utilities and helpers
+├── watch.py         # Filesystem monitoring
+├── compress.py      # Compression (future)
+└── cloud.py         # Cloud protocols (future)
+```
+
+
+## 🗺️ Roadmap
+
+### Upcoming Features
+
+- 🗜️ **In-stream zstd compression**
+- 🔍 **Enhanced remote hash detection**
+- 📄 **Configuration file support**
+- 🌩️ **Cloud provider integration**
+- 📈 **Advanced performance metrics**
+- 🔐 **Certificate-based authentication**
+
+
+## 🤝 Contributing
+
+We welcome contributions! Please check out our development setup:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate  # or .venv\Scripts\Activate.ps1 on Windows
+pip install -e .[dev]
+pytest
+```
+
+---
+
+## 📄 License
+
+Released under the **MIT License**. See [LICENSE](LICENSE) for details.
+
+---
+
+<div align="center">
+
+**Built with ❤️ for the SSH community**
+
+*Vaayu — Where files flow like air*
+
+---
+</div>
+
+> 📝 **Note**: This README was generated with AI assistance because the developer was too lazy to write comprehensive documentation (but smart enough to make AI do it properly). 😴✨