spindlex 0.5.0

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

SpindleX

A modern, high-performance SSHv2 and SFTP library.

Explore the Docs »

Quick Start • Migration Guide • Cookbook • Performance • Security • Contributing

---

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 protocol implementation with internal buffering designed for high-throughput SFTP and command execution.
• 📦 Modern Architecture: Clean, modular codebase built from the ground up for maintainability. Leverages the industry-standard cryptography library for robust, hardware-accelerated security.
• 🔄 Native Async: First-class support for asyncio with AsyncSSHClient and AsyncSFTPClient.
• 🛡️ Secure by Default: Modern algorithms like Ed25519, ECDSA, and ChaCha20-Poly1305 are prioritized. Legacy SHA-1 and weak ciphers are disabled in the default configuration.
• 🏷️ 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 high-throughput, low-latency environments. It utilizes internal read buffering (32KB chunks) and optimized packet handling to reduce system call overhead and improve protocol efficiency.

While performance varies significantly based on network conditions and hardware, SpindleX aims to provide a modern, efficient alternative to legacy Python SSH implementations.

[!TIP] Use the included spindlex-benchmark tool to evaluate performance in your specific environment.

---

🛡️ Security

• Hardened Defaults: Modern cryptographic primitives are used by default. Legacy algorithms are disabled unless explicitly configured.
• Mandatory Verification: Host key verification is enforced unless explicitly overridden.
• Privacy Aware: Built-in log sanitizers ensure credentials never reach telemetry.
• Vulnerability Reporting: See meta/SECURITY.md.

---

🤝 Contributing

Contributions are welcome! See meta/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}