通用云文档监控 skill 包,支持抓取、搜索、变更检测、对比、总结和通知
Project description
cloud-doc-monitor
一个通用的云厂商文档监控 skill 包。
对外只暴露 6 个 skill:
fetch_docsearch_docscheck_changescompare_docssummarize_diffrun_monitor
所有 skill 都统一返回:
machine: 给 OpenClaw、Claude Code、工作流系统读human: 给人读
运行环境
- Python
>=3.9 - 如果需要 BOS 上传,安装额外依赖:
pip install cloud-doc-monitor[bos]
安装
从 PyPI 安装:
pip install cloud-doc-monitor
如果需要 BOS:
pip install 'cloud-doc-monitor[bos]'
本地开发:
pip install -e .
Python 调用
from cloud_doc_monitor import CloudDocMonitorSkillSet
skills = CloudDocMonitorSkillSet(config_path="/abs/path/config.yaml")
result = skills.fetch_doc(cloud="baidu", product="VPC", doc_ref="0jwvytzll")
print(result["machine"]["title"])
print(result["human"]["summary_text"])
CLI 调用
列出 skill:
cloud-doc-monitor list-skills
抓取单篇文档:
cloud-doc-monitor run fetch_doc \
--config /abs/path/config.yaml \
--payload '{"cloud":"baidu","product":"VPC","doc_ref":"0jwvytzll","with_summary":true}'
查最近变更:
cloud-doc-monitor run check_changes \
--config /abs/path/config.yaml \
--payload '{"cloud":"aliyun","product":"/vpc","days":7,"max_pages":20,"with_summary":true}'
运行巡检:
cloud-doc-monitor run run_monitor \
--config /abs/path/config.yaml \
--payload '{"clouds":["aliyun","tencent","baidu","volcano"],"products":["vpc","eni"],"days":1,"max_pages":20,"with_summary":true,"send_notification":false,"output_format":"both"}'
更多可复制示例:
配置依赖
关键配置:
storage.backend = local|bosstorage.databasestorage.local_rootstorage.report_dirstorage.bos.*crawler.temp_dirllm.*notifications[*]monitor.default_cloudsmonitor.default_products
参考:
config.example.yaml- config.md
对外 skill 说明
fetch_doc
适合:
- 抓取某篇文档
- 打开某个产品说明页
输入:
{
"cloud": "aliyun|tencent|baidu|volcano",
"doc_ref": "url|alias|slug|doc_id",
"product": "optional",
"with_summary": true
}
search_docs
适合:
- 某个产品有哪些文档
- 帮我找相关说明页
check_changes
适合:
- 最近更新了什么
- 最近 7 天阿里云 VPC 有什么变化
compare_docs
适合:
- 对比腾讯云和百度云 ENI
- 对比不同云厂商某个功能的文档能力描述
summarize_diff
适合:
- 总结两个版本差异
- 把 diff 讲人话
run_monitor
适合:
- 运行巡检
- 生成日报
- 发通知
发包
本地构建:
./scripts/build_dist.sh
上传到 TestPyPI:
./scripts/publish_dist.sh testpypi
上传到 PyPI:
./scripts/publish_dist.sh pypi
常见环境变量:
export TWINE_USERNAME=__token__
export TWINE_PASSWORD=pypi-xxxxxxxx
如果你不想走脚本,也可以直接:
python3 -m build --sdist --wheel
python3 -m twine check dist/*
python3 -m twine upload dist/*
目录结构
cloud-doc-monitor/
├── SKILL.md
├── scripts/
├── references/
├── assets/
├── examples/
└── cloud_doc_monitor/
├── skill.py
├── tools/
├── crawlers/
├── llm.py
├── diffing.py
├── storage.py
└── notifications.py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cloud_doc_monitor-0.1.0.tar.gz
(32.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cloud_doc_monitor-0.1.0.tar.gz.
File metadata
- Download URL: cloud_doc_monitor-0.1.0.tar.gz
- Upload date:
- Size: 32.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2f987b7bb46867d109237099aed8d46e11da51acb94c5ff8c40ffca66f4e4a57
|
|
| MD5 |
404a561b612beec1ddbb3f85d47e88c1
|
|
| BLAKE2b-256 |
fcd2b95384bbd294a20f617c53d99776e87217dc55d666b1c750f12894f53eb1
|
File details
Details for the file cloud_doc_monitor-0.1.0-py3-none-any.whl.
File metadata
- Download URL: cloud_doc_monitor-0.1.0-py3-none-any.whl
- Upload date:
- Size: 35.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dcf3c49a1245e89f9f26eef02fbe10a9edce62b661016e3acf794c0623d9f79c
|
|
| MD5 |
88ddd2a347eb4ddb5453ab15e3d087d7
|
|
| BLAKE2b-256 |
e733f3a0d8cc2fa19956db278157f44291fb75d7793f58a810f4a03aa6ae8983
|