feat: Add CI for Ruff checking (#2)

* fix: Fix error in pyproject.toml

* chores: Format with ruff

* refactor: Mute lint error for unfinished sdk

* chore: update Ruff workflow

* feat: Apply settings

Author: Nativu5

.github/workflows/ruff.yml

@@ -0,0 +1,32 @@
+name: Ruff
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  lint:
+    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.x'
+
+      - name: Install Ruff
+        run: pip install ruff
+
+      - name: Format code
+        run: ruff --config pyproject.toml format .
+
+      - name: Fix lint issues
+        run: ruff --config pyproject.toml check --fix --exit-zero .
+
+      - name: Ensure no remaining lint issues
+        run: ruff --config pyproject.toml check .

netpulse-client/examples/sdk_test.py

@@ -1,5 +1,4 @@
-import asyncio
-from netpulse_client import NetPulseClient, Device
+from netpulse_client import Device, NetPulseClient
 
 # 配置信息
 ENDPOINT = "http://localhost:9000"
@@ -19,7 +18,7 @@
 
 def basic_operations():
     print("=== 基础操作示例 ===")
-    
+
     with NetPulseClient(ENDPOINT, API_KEY) as np_client:
         # 1. 执行命令
         print("\n1. 执行命令")
@@ -35,6 +34,5 @@ def basic_operations():
         print(result.request_id)
 
 
-
 if __name__ == "__main__":
-    basic_operations()
+    basic_operations()

netpulse-client/netpulse_client/__init__.py

@@ -1,11 +1,11 @@
 """
 NetPulse Client - 网络设备自动化客户端
 
-提供同步和异步的网络设备操作接口，支持命令执行和配置推送。
+提供同步和异步的网络设备操作接口, 支持命令执行和配置推送。
 
-核心方法（与API端点对应）：
+核心方法 (与API端点对应) : 
 - exec_command(): 同步执行命令 -> /device/execute
-- exec_config(): 同步推送配置 -> /device/execute  
+- exec_config(): 同步推送配置 -> /device/execute
 - bulk_command(): 同步批量执行命令 -> /device/bulk
 - bulk_config(): 同步批量推送配置 -> /device/bulk
 - aexec_command(): 异步执行命令 -> /device/execute
@@ -23,34 +23,34 @@
 """
 
 # 核心客户端类
+from .async_client import AsyncJobHandle, AsyncNetPulseClient
 from .client import NetPulseClient
-from .async_client import AsyncNetPulseClient, AsyncJobHandle
-
-# 数据模型
-from .models import (
-    ConnectionArgs,  # 主要的连接参数模型
-    Device,  # 向后兼容的Device别名
-    CommandResult,
-    ConfigResult,
-    BatchResult,
-    JobInfo,
-    WorkerInfo,
-    HealthCheckResult,
-    ConnectionTestResult,
-)
-
-# 工具函数
-from .models import create_device_request, create_batch_device_request
 
 # 异常类
 from .exceptions import (
-    NetPulseError,
     AuthenticationError,
     ConnectionError,
     JobError,
+    NetPulseError,
+    SDKValidationError,
     TimeoutError,
     ValidationError,
-    SDKValidationError,
+)
+
+# 数据模型
+# 工具函数
+from .models import (
+    BatchResult,
+    CommandResult,
+    ConfigResult,
+    ConnectionArgs,  # 主要的连接参数模型
+    ConnectionTestResult,
+    Device,  # 向后兼容的Device别名
+    HealthCheckResult,
+    JobInfo,
+    WorkerInfo,
+    create_batch_device_request,
+    create_device_request,
 )
 
 __version__ = "0.1.0"
@@ -60,7 +60,6 @@
     "NetPulseClient",
     "AsyncNetPulseClient",
     "AsyncJobHandle",
-    
     # 数据模型
     "ConnectionArgs",  # 主要的连接参数模型
     "Device",  # 向后兼容的Device别名
@@ -71,11 +70,9 @@
     "WorkerInfo",
     "HealthCheckResult",
     "ConnectionTestResult",
-    
     # 工具函数
     "create_device_request",
     "create_batch_device_request",
-    
     # 异常类
     "NetPulseError",
     "AuthenticationError",
@@ -84,4 +81,4 @@
     "TimeoutError",
     "ValidationError",
     "SDKValidationError",
-] 
+]