API 使用文档
概述
class-widgets-sdk 为创建 Class Widgets 2 插件提供了核心基类、开发工具（如脚手架和打包）以及完整的类型提示。
该包提供了开发所需的核心 SDK，必须安装在你的插件环境中。插件将在 Class Widgets 2 主应用程序中运行。
安装
pip install class-widgets-sdk
快速开始
1. 创建新插件
使用附带的 CLI 工具生成新的插件项目结构：
cw-plugin-init com.example.myplugin
2. 安装依赖
进入插件目录并以可编辑模式安装 SDK：
cd com.example.myplugin
pip install -e .
3. 使用（基类和类型）
SDK 提供了基类 CW2Plugin 和配置模型，支持完整的 IDE 自动补全和静态分析。
from ClassWidgets.SDK import CW2Plugin, ConfigBaseModel, PluginAPI
class MyConfig(ConfigBaseModel):
enabled: bool = True
text: str = "你好，世界"
class MyPlugin(CW2Plugin):
def __init__(self, api: PluginAPI):
super().__init__(api)
self.config = MyConfig()
def on_load(self):
self.api.config.register_plugin_model(self.pid, self.config)
# 你的 IDE 将提供完整的自动补全
self.api.widgets.register(
widget_id="com.example.mywidget",
name="My Widget",
qml_path="path/to/mywidget.qml"
)
4. 打包
使用附带的 CLI 工具构建并打包插件为可分发的 .cwplugin 或 .zip 文件：
cw-plugin-pack
工具
SDK 包含了强大的命令行工具，用于插件开发和分发：
| 命令 | 描述 |
|---|---|
cw-plugin-init |
生成新的插件项目脚手架。 |
cw-plugin-pack |
构建并打包插件为可分发的 .cwplugin 或 .zip 文件。 |
cw-plugin-publish |
将插件发布到 Class Widgets 插件注册中心。 |
了解更多 >
cw-plugin-init
使用交互式设置向导初始化一个新的 Class Widgets 插件项目。
用法：
# 在当前目录创建插件（交互式）
cw-plugin-init
# 在指定目录创建插件
cw-plugin-init my-plugin
# 强制覆盖已有文件
cw-plugin-init my-plugin --force
流程：
- 选择位置（当前目录或新文件夹）
- 输入插件元数据（名称、作者、ID 等）
- 确认并生成文件
cw-plugin-pack
构建并打包插件为可分发的 .cwplugin 或 .zip 文件。
# 打包当前目录（默认格式：.cwplugin）
cw-plugin-pack
# 指定格式（.cwplugin 或 .zip）
cw-plugin-pack --format zip
# 指定输出路径
cw-plugin-pack -o ./dist/my-plugin.cwplugin
# 打包指定目录
cw-plugin-pack ./my-plugin
格式
.cwplugin- 推荐的插件格式.zip- 标准归档格式
cw-plugin-publish
将插件发布到 Class Widgets 插件注册中心。该命令会读取 cwplugin.json 并将插件元数据发送到注册中心 API。
# 发布当前目录插件（从 CWPT_TOKEN 环境变量读取令牌）
cw-plugin-publish
# 使用显式令牌发布
cw-plugin-publish --token cwpt_xxxxxxxxxxxxxxxxxxxx
# 试运行 — 验证和预览（不发布到插件广场）
cw-plugin-publish --dry-run
# 使用自定义 API URL 进行调试
cw-plugin-publish --api-url http://localhost:1145
# 指定分支（默认从 git 自动检测）
cw-plugin-publish --branch dev
选项：
--token, -t— 发布令牌（或设置CWPT_TOKEN环境变量）--api-url— API 基础 URL（默认：https://plaza.cw.rinlit.cn/）--branch, -b— 仓库分支（从 git 自动检测，回退：main）--dry-run— 验证和预览而不实际发布
cwplugin.json 发布字段：
| 字段 | 必需 | 描述 |
|---|---|---|
id |
是 | 插件 ID |
name |
是 | 插件显示名称 |
version |
是 | 插件版本 |
api_version |
是 | 所需 API 版本 |
url |
是 | 仓库 URL |
description |
否 | 插件描述 |
readme |
否 | README 文件路径（默认：README.md） |
icon |
否 | 图标文件路径（默认：icon.png） |
工作原理
- 开发：安装此 SDK 包后，你可以在 IDE 中获得基类、类型提示、自动补全和静态类型检查（使用 mypy/pyright）。
- 运行时：当你的插件被 Class Widgets 2 主应用程序加载时，你的
CW2Plugin子类将被实例化并执行。
链接
许可证
本项目基于 MIT 许可证 授权 - 详见 LICENSE.md 文件。
1 maintainer
Metadata
1 maintainer
Release files for Class-Widgets-SDK 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| class_widgets_sdk-0.7.0.tar.gz | 243.2 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| class_widgets_sdk-0.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 304.5 kB
Release files / class_widgets_sdk-0.7.0.tar.gz
| Download URL | class_widgets_sdk-0.7.0.tar.gz |
|---|---|
| Size | 243.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
28811d91809ca1f99def073ea2500502ed786e5d547e64242a15cb5a21ab7fb6
|
|
BLAKE2b-256 checksum How to use checksums |
37da05609d99f478db70a243abec2cef17db2c8df6f300c620b16c15e0eb7790
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logRelease files / class_widgets_sdk-0.7.0-py3-none-any.whl
| Download URL | class_widgets_sdk-0.7.0-py3-none-any.whl |
|---|---|
| Size | 61.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e6d3a3107ab95484cf8cd5bdc5067e57d0b3329a0084e00ee87f16baca4b85bb
|
|
BLAKE2b-256 checksum How to use checksums |
9d23fc80b5274d6107391d9064ed2f9ff23fab815c8daf01d94c874f1c9a587d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logSecurity for Class-Widgets-SDK 0.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for class_widgets_sdk-0.7.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
