sdwk 0.1.0__tar.gz

sdwk-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.3
+Name: sdwk
+Version: 0.1.0
+Summary: SDW Platform SDK
+Author: 徐侨
+Author-email: 徐侨 <xu.qiao@kotei.com.cn>
+Requires-Dist: click>=8.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: questionary>=2.0.0
+Requires-Dist: jinja2>=3.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: httpx>=0.25.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# SDWK - SDW Platform SDK
+
+SDWK 是 SDW Platform 的官方 SDK，为开发者提供了一套完整的工具链，用于创建、开发和发布 SDW 平台应用。
+
+## 概述
+
+SDW Platform 是一个工作流低代码平台，用户可以通过拖拽内置节点组合成工作流图。SDWK SDK 允许开发者：
+
+- 创建自定义节点扩展平台功能
+- 开发完整的工作流图应用
+- 使用标准化的开发生命周期工具
+
+## 项目类型
+
+SDWK 支持两种项目类型：
+
+### Node 项目
+单节点处理项目，用于创建可复用的处理单元，具有：
+- 确定的输入和输出接口
+- 独立的业务逻辑处理
+- 标准化的数据模型
+
+### Graph 项目
+工作流图项目，用于创建包含多个节点及其关系的复杂工作流，支持：
+- 有向无环图结构
+- 节点间数据流转
+- 并行执行和错误处理
+
+## 快速开始
+
+### 安装
+
+```bash
+# 使用 uv 安装
+uv add sdwk
+
+# 或使用 pip 安装
+pip install sdwk
+```
+
+### 创建项目
+
+```bash
+# 交互式创建项目
+sdwk create
+
+# 或指定参数创建
+sdwk create --name my-project --type node --description "我的第一个节点"
+```
+
+### 开发和调试
+
+```bash
+# 进入项目目录
+cd my-project
+
+# 启动开发模式
+sdwk dev
+
+# 检查项目
+sdwk check
+
+# 发布项目
+sdwk publish
+```
+
+## 文档
+
+详细文档请参考 [docs](./docs/) 目录：
+
+- [开发者指南](./docs/developer/) - 快速开始、API 文档、使用指南
+- [项目规范](./docs/specifications/) - 包结构、配置文件规范
+- [平台集成](./docs/platform/) - 与 SDW Platform 对接说明
+- [架构设计](./docs/architecture/) - SDK 架构和设计原理
+
+## 系统要求
+
+- Python >= 3.10
+- uv (推荐) 或 pip
+
+## 许可证
+
+本项目采用 MIT 许可证。
+
+## 开发指南
+
+如果您想参与 SDWK SDK 的开发，请按照以下步骤设置开发环境：
+
+### 获取源代码
+
+```bash
+# 克隆项目代码
+git clone https://172.16.0.120/astri/RI-SDW-III/SDW/Platform/Platform-SDK.git sdwk
+
+# 进入项目目录
+cd sdwk
+
+# 切换到开发分支
+git checkout develop
+```
+
+### 设置开发环境
+
+```bash
+# 安装依赖
+uv sync
+
+# 安装开发钩子（代码质量检查、格式化等）
+uv run prek install
+```
+
+### 开发工作流
+
+1. **创建功能分支**：
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **进行开发**：
+   - 编写代码
+   - 添加测试
+   - 更新文档
+
+3. **代码质量检查**：
+   ```bash
+   # 运行代码检查
+   uv run ruff check
+
+   # 运行格式化
+   uv run ruff format
+
+   # 运行类型检查
+   uv run ty
+   ```
+
+4. **提交代码**：
+   ```bash
+   git add .
+   git commit -m "feat: 添加新功能描述"
+   ```
+
+5. **推送并创建 Pull Request**：
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+### 开发规范
+
+- 遵循 [项目规范](./docs/specifications/) 中的代码规范
+- 确保所有测试通过
+- 添加适当的文档和注释
+- 使用语义化的提交消息
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request 来改进 SDWK。
+
+## 联系方式
+
+- 作者：徐侨 (xu.qiao@kotei.com.cn)
+- 项目主页：[GitHub Repository]

sdwk-0.1.0/README.md

@@ -0,0 +1,161 @@
+# SDWK - SDW Platform SDK
+
+SDWK 是 SDW Platform 的官方 SDK，为开发者提供了一套完整的工具链，用于创建、开发和发布 SDW 平台应用。
+
+## 概述
+
+SDW Platform 是一个工作流低代码平台，用户可以通过拖拽内置节点组合成工作流图。SDWK SDK 允许开发者：
+
+- 创建自定义节点扩展平台功能
+- 开发完整的工作流图应用
+- 使用标准化的开发生命周期工具
+
+## 项目类型
+
+SDWK 支持两种项目类型：
+
+### Node 项目
+单节点处理项目，用于创建可复用的处理单元，具有：
+- 确定的输入和输出接口
+- 独立的业务逻辑处理
+- 标准化的数据模型
+
+### Graph 项目
+工作流图项目，用于创建包含多个节点及其关系的复杂工作流，支持：
+- 有向无环图结构
+- 节点间数据流转
+- 并行执行和错误处理
+
+## 快速开始
+
+### 安装
+
+```bash
+# 使用 uv 安装
+uv add sdwk
+
+# 或使用 pip 安装
+pip install sdwk
+```
+
+### 创建项目
+
+```bash
+# 交互式创建项目
+sdwk create
+
+# 或指定参数创建
+sdwk create --name my-project --type node --description "我的第一个节点"
+```
+
+### 开发和调试
+
+```bash
+# 进入项目目录
+cd my-project
+
+# 启动开发模式
+sdwk dev
+
+# 检查项目
+sdwk check
+
+# 发布项目
+sdwk publish
+```
+
+## 文档
+
+详细文档请参考 [docs](./docs/) 目录：
+
+- [开发者指南](./docs/developer/) - 快速开始、API 文档、使用指南
+- [项目规范](./docs/specifications/) - 包结构、配置文件规范
+- [平台集成](./docs/platform/) - 与 SDW Platform 对接说明
+- [架构设计](./docs/architecture/) - SDK 架构和设计原理
+
+## 系统要求
+
+- Python >= 3.10
+- uv (推荐) 或 pip
+
+## 许可证
+
+本项目采用 MIT 许可证。
+
+## 开发指南
+
+如果您想参与 SDWK SDK 的开发，请按照以下步骤设置开发环境：
+
+### 获取源代码
+
+```bash
+# 克隆项目代码
+git clone https://172.16.0.120/astri/RI-SDW-III/SDW/Platform/Platform-SDK.git sdwk
+
+# 进入项目目录
+cd sdwk
+
+# 切换到开发分支
+git checkout develop
+```
+
+### 设置开发环境
+
+```bash
+# 安装依赖
+uv sync
+
+# 安装开发钩子（代码质量检查、格式化等）
+uv run prek install
+```
+
+### 开发工作流
+
+1. **创建功能分支**：
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **进行开发**：
+   - 编写代码
+   - 添加测试
+   - 更新文档
+
+3. **代码质量检查**：
+   ```bash
+   # 运行代码检查
+   uv run ruff check
+
+   # 运行格式化
+   uv run ruff format
+
+   # 运行类型检查
+   uv run ty
+   ```
+
+4. **提交代码**：
+   ```bash
+   git add .
+   git commit -m "feat: 添加新功能描述"
+   ```
+
+5. **推送并创建 Pull Request**：
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+### 开发规范
+
+- 遵循 [项目规范](./docs/specifications/) 中的代码规范
+- 确保所有测试通过
+- 添加适当的文档和注释
+- 使用语义化的提交消息
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request 来改进 SDWK。
+
+## 联系方式
+
+- 作者：徐侨 (xu.qiao@kotei.com.cn)
+- 项目主页：[GitHub Repository]

sdwk-0.1.0/pyproject.toml

@@ -0,0 +1,182 @@
+[project]
+name = "sdwk"
+version = "0.1.0"
+description = "SDW Platform SDK"
+readme = "README.md"
+authors = [
+    { name = "徐侨", email = "xu.qiao@kotei.com.cn" }
+]
+requires-python = ">=3.10"
+dependencies = [
+    "click>=8.0.0",
+    "rich>=13.0.0",
+    "questionary>=2.0.0",
+    "jinja2>=3.0.0",
+    "pydantic>=2.0.0",
+    "httpx>=0.25.0"
+]
+
+[project.scripts]
+sdwk = "sdwk.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.9.0,<0.10.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pip>=25.3",
+    "prek>=0.2.22",
+    "pytest>=9.0.2",
+    "ruff>=0.14.9",
+    "ty>=0.0.2",
+]
+
+
+[tool.ty.terminal]
+output-format = "concise"
+
+[tool.ty.rules]
+#unknown-argument = 'ignore'
+unresolved-attribute = 'ignore'
+#missing-argument = 'ignore'
+invalid-argument-type = 'ignore'
+#unresolved-import = 'ignore'
+#not-iterable = 'ignore'
+invalid-parameter-default = 'ignore'
+
+deprecated = 'ignore'
+#too-many-positional-arguments = 'ignore'
+#unresolved-reference = 'ignore'
+call-non-callable = 'ignore'
+invalid-return-type = 'ignore'
+#unsupported-operator = 'ignore'
+#invalid-assignment = 'ignore'
+
+
+# ruff相关配置(检查&格式化)
+# 自动修复规范问题
+# ruff check --preview --fix --unsafe-fixes
+# 格式化项目
+# ruff format (uv format --preview-features format)
+[tool.ruff]
+preview = true
+line-length = 320
+# exclude = ["__init__.py"]  # 忽略所有 __init__.py 文件
+exclude = [
+    "src/sdwk/templates/",
+]
+
+
+# ty规则：https://docs.astral.sh/ty/reference/rules/
+
+[tool.ruff.lint]
+# pylint规则
+# https://pylint.pycqa.org/en/latest/user_guide/messages/messages_overview.html
+# pylint规则迁移至uv，某些规则不支持（部分属于pylint定制化规则，非标准）
+# https://github.com/astral-sh/ruff/issues/970
+# https://github.com/astral-sh/ruff/issues/1774
+# 基础规则集
+select = [
+    "A", "ARG", "B", "C", "E", "F", "G", "G", "I", "ISC", "N", "PIE", "PLE", "Q", "R", "RET", "SLF", "T", "TID", "UP", "W",
+    "PLW",
+    "BLE",
+    "TRY",
+    "SIM",
+    "S",
+    "FIX",
+    "PLC",
+    "PLR",
+    "D",
+    "D103",
+    "D100",
+    "PLR0916",
+]
+# 平台检测
+# pylint src --disable=import-error,no-member,line-too-long,broad-exception-caught,broad-exception-raised,logging-fstring-interpolation,too-many-positional-arguments,too-many-instance-attributes,too-many-arguments,too-many-locals,too-many-branches,too-many-statements,too-many-nested-blocks,raise-missing-from,singleton-comparison,too-few-public-methods,consider-iterating-dictionary,consider-using-set-comprehension,not-callable,logging-not-lazy,consider-using-f-string,invalid-name,too-many-public-methods,global-statement,unnecessary-pass,wildcard-import,consider-using-join,cell-var-from-loop,too-many-return-statements,import-outside-toplevel,bare-except,subprocess-run-check,consider-using-dict-items,too-many-boolean-expressions,too-many-lines
+
+# 圈复杂度
+mccabe = { max-complexity = 24 }
+
+ignore = [
+    "BLE001",
+    "S110",
+    "PLW0603",
+    "TRY300",
+    "TRY004",
+    "PLC0415",
+    "TRY002",
+    "PLC1901",
+    "TRY003",
+    "PLR0912",
+    "S112",
+    "PLR2004",
+    "PLR0917",
+    "PLR0913",
+    "PLR1702",
+    "PLR0914",
+    "PLR0915",
+    "PLR6301",
+    "D101",
+    "PLW2901",
+    "PLC2701",
+    "TRY301",
+    "D205",
+    "D203", # 和D211不能同时启用，这里选择忽略D203
+    "D213", # 和D212不能同时启用，这里选择忽略D213
+    "D107",
+    "SIM108",
+    "FIX002",
+    "SIM105",
+    "TRY401",
+    "S501",
+    "S324",
+    "S104",
+    "S101",
+    "SLF001",
+    "D102",
+    "D103",
+    "ARG002",
+    "G004",
+    "B904",
+    "G201",
+    "A001",
+    "A002",
+    "B024",
+    "N818",
+    "ARG001",
+    "E402",
+    "D105",
+    "N802",
+    "B008",
+    "S311",
+    "F811",
+    "B903",
+    "D100",
+    "ARG004",
+    "PLR0911",
+    "D417",
+    "S105",
+    "S106",
+    "S107",
+    "E722",
+    "S603",
+    "D106",
+    "S404",
+    "S701",
+    "D104",
+]
+
+[tool.ruff.lint.isort]
+# 导入分组顺序（默认：标准库 → 第三方库 → 本地库）
+section-order = [
+    "standard-library", # 标准库（如 sys, os）
+    "third-party", # 第三方库（如 pandas, requests）
+    "first-party", # 本地项目导入
+    "local-folder", # 同一目录下的本地导入
+]
+
+# 允许在导入中使用别名（如 import pandas as pd）
+force-sort-within-sections = true
+split-on-trailing-comma = true  # 多行导入时在末尾添加逗号
+force-wrap-aliases = true       # 强制别名导入使用多行格式（如 import a as b 超过长度时换行）

sdwk-0.1.0/src/sdwk/__init__.py

@@ -0,0 +1,2 @@
+def hello() -> str:
+    return "Hello from platform-sdk!"

sdwk-0.1.0/src/sdwk/cli.py

@@ -0,0 +1,27 @@
+"""SDW Platform SDK CLI."""
+
+import click
+from rich.console import Console
+
+from .commands.check import check
+from .commands.create import create
+from .commands.dev import dev
+from .commands.publish import publish
+
+console = Console()
+
+
+@click.group()
+@click.version_option(version="0.1.0", prog_name="sdwk")
+def main():
+    """SDW Platform SDK - 用于创建、开发和发布SDW平台应用的工具."""
+
+
+# 注册子命令
+main.add_command(create)
+main.add_command(dev)
+main.add_command(check)
+main.add_command(publish)
+
+if __name__ == "__main__":
+    main()

sdwk-0.1.0/src/sdwk/commands/__init__.py

@@ -0,0 +1 @@
+"""Commands module for SDW Platform SDK CLI."""