PY OS Improved 第三方软件包（SAP）开发规范

目录

• 1. 第三方软件打包规范
• 2. 第三方软件代码规范
• 3. 第三方软件安装&卸载
• 4. 补充说明

1. 第三方软件打包规范

1.1 主程序文件名

必须为 main.py，安装后根据 info.json 中的名称重命名。

1.2 程序依赖库

必须包含 requirements.txt 文件：

pygame
numpy

或无依赖：

# No such library needed

1.3 软件基本信息文件

{
    "name": "example",
    "version": "1.0.0",
    "author": "developer",
    "description": "This is an example software package.",
    "category": "example",
    "tags": ["example", "example_tag"],
    "min_python_version": "3.8",
    "target_python_version": "3.12",
    "compatible_os": "windows"
}

1.4 第三方软件包名

• 全部小写，多个单词用下划线连接
• 不得与现有包名或系统命令重复
• 示例：example → example.py

1.5 软件包文件目录结构

软件包(example.sap)
├── ? data
│   ├── ? config.json
├── ? resources
│   ├── ? example.png
├── ? depends
│   ├── ? module1.py
├── ? docs
│   ├── ? UserGuide.md
├── ! main.py
├── ! requirements.txt
├── ! info.json
├── ? README.md

1.6 软件包封装格式

使用 ZIP 格式打包，扩展名改为 .sap

1.7 软件包兼容性

必须兼容 Python 3.8，在 info.json 中指定版本要求。

2. 第三方软件代码规范

2.1 注释

#!/usr/bin/env python3

"""
@ Name: DE_NumGuess
@ Auther: ElofHew
@ Version: 2.3
@ Description: A simple number guessing game.
@ Date: 2025.01.01
"""

2.2 报错处理

try:
    # 可能出现的错误代码
except Exception as e:
    print("Error:", e)

2.3 代码测试

测试版本命名：example_beta, example_alpha

3. 第三方软件安装&卸载

使用 Shizuku 包管理器：

shizuku install example
shizuku remove example

4. 补充说明

规范仅供参考，开发者可根据实际情况调整。