Class Widgets SDK

适用于 Class Widgets 2 插件开发的完整 SDK、工具和类型提示。

[!NOTE]

本项目还处在开发阶段，API 接口可能随时发生变化，敬请谅解。

This project is still in development. The API may change at any time, so please bear with us.

可从 Class-Widgets/Plugin-Template-V2 获取最新的插件模板、工作流以快速开始。

概述

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 子类将被实例化并执行。

[!IMPORTANT]

该包是插件的开发工具包。插件必须在 Class Widgets 2 主应用程序中测试。

SDK 的导入路径为 ClassWidgets.SDK。

链接

许可证

本项目基于 MIT 许可证 授权 - 详见 LICENSE.md 文件。

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

class_widgets_sdk-0.5.0.tar.gz (235.7 kB view details)

Uploaded Aug 12, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

class_widgets_sdk-0.5.0-py3-none-any.whl (58.1 kB view details)

Uploaded Aug 12, 2026 Python 3

File details

Details for the file class_widgets_sdk-0.5.0.tar.gz.

File metadata

Download URL: class_widgets_sdk-0.5.0.tar.gz
Upload date: Aug 12, 2026
Size: 235.7 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for class_widgets_sdk-0.5.0.tar.gz
Algorithm	Hash digest
SHA256	`754c9ea7e96e7345fa445c1dddf1fae72d8db5f8b3315c7dab1f0dd46bf9d9b6`
MD5	`e6e2c956081083eb0ffe634f9fb09ad6`
BLAKE2b-256	`bfce672916865513851c24fa9aba3723c127f43ac76dc0cd253b6746cb4c3c22`

See more details on using hashes here.

Provenance

The following attestation bundles were made for class_widgets_sdk-0.5.0.tar.gz:

Publisher: python-publish.yml on Class-Widgets/class-widgets-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: class_widgets_sdk-0.5.0.tar.gz
- Subject digest: 754c9ea7e96e7345fa445c1dddf1fae72d8db5f8b3315c7dab1f0dd46bf9d9b6
- Sigstore transparency entry: 2431677898
- Sigstore integration time: Aug 12, 2026
Source repository:
- Permalink: Class-Widgets/class-widgets-sdk@4bd8b88d92e1dd34d3be5033c3f5767dcd26972d
- Branch / Tag: refs/tags/v0.5.0
- Owner: https://github.com/Class-Widgets
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: python-publish.yml@4bd8b88d92e1dd34d3be5033c3f5767dcd26972d
- Trigger Event: push

File details

Details for the file class_widgets_sdk-0.5.0-py3-none-any.whl.

File metadata

Download URL: class_widgets_sdk-0.5.0-py3-none-any.whl
Upload date: Aug 12, 2026
Size: 58.1 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for class_widgets_sdk-0.5.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`82fafa260fc298f0e8423c5e648ff5e7a1478a9b4eb0ca0ebe23d25ddc57d027`
MD5	`28f7d477ec127292b5d61ecf40e7694b`
BLAKE2b-256	`a9e553b5b52bf37fd6a3254a8c4d774becf0abbb1c08cfe46508e07f85f3edd8`

See more details on using hashes here.

Provenance

The following attestation bundles were made for class_widgets_sdk-0.5.0-py3-none-any.whl:

Publisher: python-publish.yml on Class-Widgets/class-widgets-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: class_widgets_sdk-0.5.0-py3-none-any.whl
- Subject digest: 82fafa260fc298f0e8423c5e648ff5e7a1478a9b4eb0ca0ebe23d25ddc57d027
- Sigstore transparency entry: 2431677970
- Sigstore integration time: Aug 12, 2026
Source repository:
- Permalink: Class-Widgets/class-widgets-sdk@4bd8b88d92e1dd34d3be5033c3f5767dcd26972d
- Branch / Tag: refs/tags/v0.5.0
- Owner: https://github.com/Class-Widgets
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: python-publish.yml@4bd8b88d92e1dd34d3be5033c3f5767dcd26972d
- Trigger Event: push

Release history Release notifications | RSS feed

0.6.0

Aug 14, 2026 2 files

This release

0.5.0 This release

Aug 12, 2026 2 files

Jul 12, 2026 2 files

Feb 22, 2026 2 files

Feb 18, 2026 2 files

Jan 10, 2026 2 files

Jan 10, 2026 2 files

Jan 9, 2026 2 files

Dec 26, 2025 2 files

Dec 17, 2025 2 files

Dec 10, 2025 2 files

Class-Widgets-SDK 0.5.0

Class Widgets SDK

概述

安装

快速开始

1. 创建新插件

2. 安装依赖

3. 使用（基类和类型）

4. 打包

工具

`cw-plugin-init`

流程：

`cw-plugin-pack`

格式

`cw-plugin-publish`

选项：

`cwplugin.json` 发布字段：

工作原理

链接

许可证

Key dates

1 maintainer

Requires

Provides Extra

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

Release history Release notifications | RSS feed

Class-Widgets-SDK 0.5.0

Class Widgets SDK

概述

安装

快速开始

1. 创建新插件

2. 安装依赖

3. 使用（基类和类型）

4. 打包

工具

cw-plugin-init

流程：

cw-plugin-pack

格式

cw-plugin-publish

选项：

cwplugin.json 发布字段：

工作原理

链接

许可证

Key dates

1 maintainer

Requires

Provides Extra

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

Release history Release notifications | RSS feed

`cw-plugin-init`

`cw-plugin-pack`

`cw-plugin-publish`

`cwplugin.json` 发布字段：