ToYOhin/open-source-adapter
GitHub: ToYOhin/open-source-adapter
一个基于 Python 标准库的 CLI 与 Codex Skill,帮助团队在引入开源依赖前系统评估其健康度、合规性与安全风险,并生成适配层脚手架。
Stars: 0 | Forks: 0
# 开源 Adapter
Codex skill 和标准库 Python CLI,用于评估开源依赖是否安全到可以采用。
[](https://github.com/ToYOhin/open-source-adapter/actions/workflows/oss-audit.yml)
[](https://github.com/ToYOhin/open-source-adapter/releases)
[](LICENSE)
## 为什么使用它
Open Source Adapter 为 Codex 提供了一个可重复的采用工作流,以便在第三方库进入你的代码库之前进行评估:
- 评估仓库健康度、许可证匹配度、治理、维护和风险
- 通过 Markdown、JSON 或 CSV 输出比较替代方案
- 运行 CVE 检查、GitHub 安全态势审计以及最小 SBOM 生成
- 在临时环境中对包进行冒烟测试
- 为常用语言生成轻量级 adapter 层模板
运行时代码仅使用 Python 标准库。
## 快速开始
```
python scripts\oss_cli.py eval https://github.com/axios/axios --json
python scripts\oss_cli.py score https://github.com/axios/axios --preset enterprise --json
python scripts\oss_cli.py compare https://github.com/axios/axios https://github.com/nodejs/undici --format csv --output compare.csv
python scripts\oss_cli.py security batch-osv PyPI requests
```
## 功能
| 命令 | 目的 |
|---|---|
| `eval` | 根据 License、Activity、Community、Governance 和 Risk 对 GitHub 或 GitLab 仓库进行评分 |
| `score` | 使用自定义权重或内置的 `default`、`enterprise` 和 `startup` 预设重新评分 |
| `compare` | 对多个仓库进行排名并导出 Markdown、JSON 或 CSV |
| `analyze` | 提取 README/CHANGELOG 信号并评估维护状态 |
| `security` | 查询 OSV,审计 GitHub 安全态势,或生成最小 SBOM |
| `quickstart` | 在临时目录中安装包并运行冒烟测试 |
| `integrate` | 为 TypeScript、JavaScript、Python、Go 或 Rust 生成 adapter 脚手架 |
直接脚本入口点仍然保留在 `scripts/` 下,而 `scripts/oss_cli.py` 是推荐的统一接口。
## Codex Skill 布局
`SKILL.md` 将用户意图路由到专注的 prompt 模板:
| 意图 | 文件 |
|---|---|
| 评估、评分、比较 | `prompts/01-evaluate.md` |
| 安全、CVE、SBOM | `prompts/02-security.md` |
| README、CHANGELOG、维护 | `prompts/03-analyze.md` |
| 快速开始、adapter 生成 | `prompts/04-integrate.md` |
| 维护、升级、回滚 | `prompts/05-maintain.md` |
示例位于 `examples/`,可重用的背景资料位于 `references/`,回归测试位于 `tests/`。
## 示例
机器可读的示例输出:
- [`examples/eval-requests.json`](examples/eval-requests.json):来自 `python scripts\oss_cli.py eval https://github.com/psf/requests --json` 的即时输出。
- [`examples/compare-http-clients.csv`](examples/compare-http-clients.csv):来自 `python scripts\oss_cli.py compare https://github.com/axios/axios https://github.com/nodejs/undici --format csv` 的即时输出。
分数和仓库元数据可能会发生变化;在做出采用决定之前,请重新运行命令。
## 维护者交接
长期维护说明位于 `docs/` 下,以保持仓库根目录的关注点集中:
- [`docs/maintenance-handoff.md`](docs/maintenance-handoff.md) 记录了当前的权威源路径、验证清单、发布流程和下一个任务选项。
- [`docs/new-conversation-prompt.md`](docs/new-conversation-prompt.md) 是一个简洁的 prompt,用于在新的 Codex 窗口中继续维护。
- [`docs/roadmap.md`](docs/roadmap.md) 概述了开源改进路径。
## 质量
```
python -m pytest tests/ -q
```
当前基准:在 GitHub Actions 中跨 Python 3.11、3.12 和 3.14 进行了 196 项测试。
覆盖率包括评分边界、平台 adapter、CLI 调度、比较 JSON/CSV 渲染、示例 fixture 验证、缓存行为、README/CHANGELOG 提取以及安全报告回归。
## 作为本地 Skill 安装
```
xcopy /E /I open-source-adapter %USERPROFILE%\.codex\skills\open-source-adapter
```
在 macOS 或 Linux 上:
```
cp -r open-source-adapter ~/.codex/skills/open-source-adapter
```
## 发布
当前版本:[`v0.1.1`](https://github.com/ToYOhin/open-source-adapter/releases/tag/v0.1.1)。
请参阅 [`CHANGELOG.md`](CHANGELOG.md)、[`RELEASE_NOTES.md`](RELEASE_NOTES.md)、[`SECURITY.md`](SECURITY.md) 和 [`CONTRIBUTING.md`](CONTRIBUTING.md)。
## License
MIT
标签:Python, SOC Prime, 域名收集, 安全规则引擎, 开发工具, 开源依赖评估, 无后门, 逆向工具