spindlex 0.4.2

A modern, high-performance, pure-Python SSHv2 and SFTP client/server library

SpindleX

A modern, high-performance, pure-Python SSHv2 and SFTP library.

Explore the Docs »

Quick Start • Migration Guide • Cookbook • Performance • Security

---

SpindleX is a modern SSH protocol implementation engineered for speed, security, and a seamless developer experience. It provides a significantly more performant and cleaner alternative to legacy Python SSH libraries.

✨ Key Features

• 🚀 High Performance: Optimized with Adaptive Buffering and TCP Fast-Path. Up to 60% faster SFTP transfers.
• 📦 Zero Dependencies: Pure-Python core. No gcc, no python-dev. Perfect for minimal Docker images.
• 🔄 Native Async: First-class support for asyncio with AsyncSSHClient and AsyncSFTPClient.
• 🛡️ Modern Security: Ed25519, ECDSA, ChaCha20-Poly1305 by default.
• 🏷️ Fully Typed: 100% type-hinted codebase for robust IDE integration.

---

🚀 Quick Start

Installation

# Using pip
pip install spindlex

# Using uv (recommended)
uv pip install spindlex

Basic Usage

Synchronous Example

from spindlex import SSHClient
from spindlex.hostkeys.policy import AutoAddPolicy

with SSHClient() as client:
    client.set_missing_host_key_policy(AutoAddPolicy())
    client.connect('example.com', username='admin')
    
    stdin, stdout, stderr = client.exec_command('uptime')
    print(f"Status: {stdout.read().decode().strip()}")

Asynchronous Example

import asyncio
from spindlex import AsyncSSHClient

async def run():
    async with AsyncSSHClient() as client:
        await client.connect('example.com', username='admin')
        stdin, stdout, stderr = await client.exec_command('uptime')
        print(await stdout.read())

asyncio.run(run())

---

⚡ Performance

SpindleX is designed for low-latency environments. In head-to-head comparisons, SpindleX demonstrates a commanding lead in protocol efficiency:

Operation	SpindleX (avg)	Traditional (avg)	Improvement
Handshake & Connect	0.035s	0.077s	54% Faster
SFTP Transfer (10MB)	0.019s	0.061s	69% Faster

---

🛡️ Security

• Hardened Defaults: Legacy SHA-1 and weak ciphers are disabled by design.
• Mandatory Verification: Host key verification is enforced unless explicitly overridden.
• Privacy Aware: Built-in log sanitizers ensure credentials never reach telemetry.
• Vulnerability Reporting: See SECURITY.md.

---

🤝 Contributing

Contributions are welcome! See CONTRIBUTING.md to get started.

---

📄 License

SpindleX is released under the MIT License. See LICENSE for the full text.

---

_{Developed with precision by Di3Z1E.
© 2024 SpindleX Project}