脚本库 (Scripts)
常用辅助脚本,用于 FDE 交付物上传、知识库与飞书对接、图谱运维等。
脚本目录
| 脚本 | 用途 | 运行环境 | 使用说明 |
|---|---|---|---|
| oss-upload.py | 上传生成的 HTML 报告及图谱产物到阿里云 OSS | Python 3 + oss2 | 用于快速分发交付物给客户 |
| feishu-doc-creator.py | 将本地 Markdown 文档一键同步/导入到飞书 Docx | Python 3 + requests | 用于团队飞书文档的自动同步 |
使用指南
1. 阿里云 OSS 上传脚本
本脚本用于将本地生成的交付物(如可视化图谱 graph.html 或 MBB HTML 报告)上传至阿里云 OSS 并获取可公开访问的 URL。
运行环境准备:
pip install oss2 python-dotenv配置环境变量 (.env 或系统环境变量):
OSS_ACCESS_KEY_ID=your_access_key_id
OSS_ACCESS_KEY_SECRET=your_access_key_secret
OSS_ENDPOINT=https://oss-cn-hangzhou.aliyuncs.com命令行使用:
python oss-upload.py \
--file path/to/report.html \
--bucket momodi-20251229 \
--object-name reports/fde/your-client-report.html2. 飞书文档自动生成脚本
本脚本用于解析 Markdown 格式文件(如知识库文档或项目复盘),通过飞书 OpenAPI 自动在飞书云文档中创建一个排版优雅的 Docx 文档。
运行环境准备:
pip install requests python-dotenv在飞书开放平台创建企业自定义应用,并开通以下权限:
docx:document(获取和更新文档)drive:file(获取和更新云空间文件)
配置环境变量 (.env):
FEISHU_APP_ID=cli_xxxxxxxxxxxxxx
FEISHU_APP_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx命令行使用:
python feishu-doc-creator.py \
--file path/to/document.md \
--title "【FDE】项目复盘 - 客户A" \
--folder folder_token_here收录标准
- 必须包含
--help命令行自文档说明。 - 必须有合理的错误处理(如网络故障、授权失效、本地文件缺失)。
- 不得在脚本中硬编码敏感 Key(如 AppSecret 或 AccessKey)。
- 修改或新增脚本后,需同步更新此 README 索引。