Merge branch 'dev' into master

Author: tkspuk

.github/workflows/docs.yml

@@ -0,0 +1,50 @@
+name: Documentation Build
+
+on:
+  push:
+    branches: ["master"]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".readthedocs.yaml"
+      - "pyproject.toml"
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".readthedocs.yaml"
+      - "pyproject.toml"
+
+jobs:
+  build-docs:
+    if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Verify MkDocs configuration
+        run: mkdocs --version
+
+      - name: Build documentation
+        run: mkdocs build --strict
+
+      - name: Upload documentation artifacts
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: site/
+          retention-days: 7
+

.gitignore

@@ -31,4 +31,7 @@ docs-local/
 tests/
 site*
 
+# Paramiko driver examples config
+examples/paramiko-driver/common.py
+
 

CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## [0.2.0] - 2025-11-09
+
+### Added
+
+- **Paramiko 驱动**: 新增 Paramiko 驱动，支持 Linux 服务器管理
+  - 支持多种认证方式（密码、密钥文件、密钥内容）
+  - 支持 SFTP 文件传输（上传/下载/断点续传）
+  - 支持 SSH 代理/跳板机连接
+  - 支持 sudo 权限执行和 PTY 模式
+
+## [0.1.0] - 2025-7-04
+
+### Added
+
+- 初始版本发布
+- 支持 Netmiko、NAPALM、PyEAPI 驱动
+- 支持长连接技术、分布式架构、插件系统
+- 支持模板引擎（Jinja2、TextFSM、TTP）和 Webhook 通知
+

README-zh.md

@@ -32,6 +32,8 @@ NetPulse 提供了强大的插件系统，支持多种功能扩展：
 * **设备驱动**: 
   - 支持 Netmiko (Cisco/Huawei/Juniper等)
   - 支持 NAPALM (配置管理/状态检查)
+  - 支持 PyEAPI (Arista EOS)
+  - 支持 Paramiko (Linux服务器)
   - 支持自定义协议扩展
 
 * **模板引擎**: 

README.md

@@ -32,6 +32,8 @@ NetPulse offers a powerful plugin system supporting various functional extension
 * **Device Drivers**: 
   - Netmiko support (Cisco/Huawei/Juniper etc.)
   - NAPALM support (Configuration management/State verification)
+  - PyEAPI support (Arista EOS)
+  - Paramiko support (Linux servers)
   - Custom protocol extension support
 
 * **Template Engine**: 

docs/en/api/api-overview.md

@@ -83,6 +83,7 @@ Device Operation API provides device query, configuration, and connection testin
 - Netmiko (SSH) - Universal SSH connection
 - NAPALM (multi-vendor) - Standardized interface
 - PyEAPI (Arista-specific) - HTTP/HTTPS API
+- Paramiko (SSH) - Linux server management
 
 For detailed information, see: [Device Operation API](./device-api.md)
 
@@ -129,6 +130,11 @@ For detailed information, see: [Job Management API](./job-api.md)
 - **Connection Method**: HTTP/HTTPS API
 - **Features**: Native API support, excellent performance
 
+### Paramiko (Linux Servers)
+- **Device Types**: Linux servers (Ubuntu, CentOS, Debian, etc.)
+- **Connection Method**: SSH
+- **Features**: Native SSH, supports file transfer, proxy connections, sudo, etc.
+
 ## Queue Strategies
 
 NetPulse supports two queue strategies, and the system will automatically select the appropriate strategy based on driver type:
@@ -140,12 +146,12 @@ NetPulse supports two queue strategies, and the system will automatically select
 - **Use Cases**: Frequent operations on the same device, need to maintain connection state
 
 ### FIFO Queue (fifo)
-- **Applicable Drivers**: PyEAPI (HTTP/HTTPS stateless connections)
+- **Applicable Drivers**: PyEAPI (HTTP/HTTPS stateless connections), Paramiko (Linux servers)
 - **Features**: First-in-first-out, new connection each time
 - **Advantages**: Simple and efficient, suitable for stateless operations
-- **Use Cases**: HTTP API calls, no need to maintain connection state
+- **Use Cases**: HTTP API calls, long-running tasks, no need to maintain connection state
 
-> **Tip**: If `queue_strategy` is not specified, the system will automatically select based on driver type (Netmiko/NAPALM → `pinned`, PyEAPI → `fifo`)
+> **Tip**: If `queue_strategy` is not specified, the system will automatically select based on driver type (Netmiko/NAPALM → `pinned`, PyEAPI/Paramiko → `fifo`)
 
 ## Core Parameters Quick Reference
 

docs/en/api/device-api.md

@@ -293,7 +293,7 @@ Driver-specific parameters, vary by driver type and operation type. **Most scena
 }
 ```
 
-> **Detailed Parameter Description**: Please refer to driver-specific documentation ([Netmiko](../drivers/netmiko.md), [NAPALM](../drivers/napalm.md), [PyEAPI](../drivers/pyeapi.md))
+> **Detailed Parameter Description**: Please refer to driver-specific documentation ([Netmiko](../drivers/netmiko.md), [NAPALM](../drivers/napalm.md), [PyEAPI](../drivers/pyeapi.md), [Paramiko](../drivers/paramiko.md))
 
 ### options
 
@@ -615,6 +615,36 @@ response = requests.post(
 }
 ```
 
+#### Paramiko (Linux Servers)
+
+**Basic Connection Test**:
+```json
+{
+  "driver": "paramiko",
+  "connection_args": {
+    "host": "192.168.1.100",
+    "username": "admin",
+    "password": "your_password",
+    "port": 22,
+    "timeout": 30.0
+  }
+}
+```
+
+**Key Authentication Example**:
+```json
+{
+  "driver": "paramiko",
+  "connection_args": {
+    "host": "192.168.1.100",
+    "username": "admin",
+    "key_filename": "/path/to/private_key",
+    "passphrase": "your_key_passphrase",
+    "port": 22
+  }
+}
+```
+
 ### Connection Parameter Description
 
 **Netmiko Parameters**:
@@ -689,7 +719,7 @@ response = requests.post(
 
 ### Quick Tips
 
-- **Driver Selection**: Netmiko (universal SSH), NAPALM (multi-vendor), PyEAPI (Arista-specific)
+- **Driver Selection**: Netmiko (universal SSH), NAPALM (multi-vendor), PyEAPI (Arista-specific), Paramiko (Linux servers)
 - **Queue Strategy**: Usually no need to specify, system will automatically select based on driver
 - **Error Handling**: Implement retry mechanism, record detailed error information
 - **Task Tracking**: Use `/job` interface to query task status, or use webhook callbacks

docs/en/architecture/architecture-overview.md

@@ -289,7 +289,7 @@ NetPulse improves system performance, availability, and scalability through the
 **Design Philosophy**: Extend functionality through plugin mechanism, drivers are one type of plugin.
 
 **Supported Extensions**:
-- **Device Drivers**: Can add new device drivers (currently supports Netmiko, NAPALM, pyeAPI, etc.)
+- **Device Drivers**: Can add new device drivers (currently supports Netmiko, NAPALM, PyEAPI, Paramiko, etc.)
 - **Template Engines**: Can add new template formats (currently supports Jinja2, TextFSM, TTP, etc.)
 - **Scheduling Algorithms**: Can add new scheduling strategies (currently supports greedy, minimum load, etc.)
 - **Notification Mechanisms**: Can add new Webhook implementations

docs/en/architecture/driver-system.md

@@ -1,14 +1,15 @@
 # Device Driver System
 
-NetPulse provides extensible driver support through its plugin system. Users can use the three built-in supported drivers, or develop custom drivers as needed.
+NetPulse provides extensible driver support through its plugin system. Users can use the four built-in supported drivers, or develop custom drivers as needed.
 
 ## Core Drivers
 
 | Driver   | Protocol      | Vendor Support              | Key Features                              | Dependencies      |
 |----------|---------------|-----------------------------|-------------------------------------------|-------------------|
 | Netmiko  | SSH/Telnet    | 30+ vendors                 | CLI command execution, **SSH keepalive** | netmiko~=4.5.0    |
 | NAPALM   | API/SSH       | Multi-vendor (Cisco/Juniper/Arista) | Configuration management, state collection | napalm~=5.0.0     |
-| pyeAPI   | HTTP/HTTPS    | Arista EOS only             | Native EOS API access, HTTP-based eAPI | pyeapi~=1.0.4     |
+| PyEAPI   | HTTP/HTTPS    | Arista EOS only             | Native EOS API access, HTTP-based eAPI | pyeapi~=1.0.4     |
+| Paramiko | SSH           | Linux servers               | Native SSH, file transfer, proxy connections, sudo | paramiko~=3.0.0  |
 
 ## Specify Device Driver
 
@@ -60,6 +61,12 @@ When using [Pinned Worker](./architecture-overview.md) with Netmiko driver, the
 
 Users can configure SSH keepalive time through the `keepalive` parameter. When SSH keepalive fails, Pinned Worker will automatically exit. When tasks are sent again, a new Pinned Worker will be created to connect to the device.
 
+## Paramiko
+
+Paramiko driver is used to manage Linux servers in NetPulse, implemented based on native SSH protocol. Paramiko driver supports command execution, file transfer, proxy connections, sudo, and other advanced features, suitable for system monitoring, configuration management, software deployment, and other scenarios.
+
+Paramiko driver defaults to FIFO queue strategy (short connection), suitable for long-running tasks and file transfer scenarios. Unlike Netmiko driver, Paramiko driver does not implement long connection reuse, and will disconnect after each task execution.
+
 ## Long Connection Technology
 
 ### Technology Overview

docs/en/architecture/plugin-system.md

@@ -23,6 +23,7 @@ graph TB
     Driver --> Netmiko[Netmiko Driver]
     Driver --> NAPALM[NAPALM Driver]
     Driver --> PyEAPI[PyEAPI Driver]
+    Driver --> Paramiko[Paramiko Driver]
     Driver --> Custom[Custom Driver...]
     
     style Plugin fill:#E6F4EA,stroke:#4B8B3B,stroke-width:3px
@@ -80,7 +81,7 @@ graph TD
 | **Name Attribute** | `driver_name` |
 | **Directory** | `netpulse/plugins/drivers/` |
 | **Global Variable** | `drivers` |
-| **Built-in Implementation** | Netmiko, NAPALM, pyeAPI |
+| **Built-in Implementation** | Netmiko, NAPALM, PyEAPI, Paramiko |
 
 **Core Methods**:
 - `connect()`: Establish device connection