Skip to content

Commit 3714510

Browse files
committed
docs: improve package positioning for 0.1.3
1 parent fb54459 commit 3714510

4 files changed

Lines changed: 93 additions & 6 deletions

File tree

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,52 @@
11
# code2skill
22

3+
[![PyPI version](https://img.shields.io/pypi/v/code2skill)](https://pypi.org/project/code2skill/)
4+
[![Python versions](https://img.shields.io/pypi/pyversions/code2skill)](https://pypi.org/project/code2skill/)
5+
[![License](https://img.shields.io/pypi/l/code2skill)](https://github.com/oceanusXXD/code2skill/blob/main/LICENSE)
6+
37
中文优先,后附英文快速说明。
48
Chinese first, with an English quick reference at the end.
59

6-
`code2skill` 是一个面向 Python 仓库的 CLI。它会把真实代码仓库编译成一组结构化项目知识和 Skill 文档,供 Cursor、Claude Code、Codex、Copilot、Windsurf 等 AI 编程助手消费。
10+
`code2skill` 是一个面向 Python 仓库的 CLI。它会把真实代码仓库转换成结构化项目知识、AI 可消费的 Skill 文档,以及可以直接适配到 Cursor、Claude Code、Codex、Copilot、Windsurf 的规则文件。
11+
12+
它的目标不是“总结仓库”,而是生成能直接用于后续编码、审查、补丁编写和增量更新的高密度上下文。
13+
14+
核心定位:
15+
16+
- 输入:一个真实 Python 仓库
17+
- 中间产物:`project-summary.md``skill-blueprint.json``skill-plan.json`
18+
- 最终产物:`skills/*.md``AGENTS.md``CLAUDE.md``copilot-instructions.md` 等 AI 规则文件
19+
- 目标工具:Cursor、Claude Code、Codex、GitHub Copilot、Windsurf
20+
21+
如果你在找下面这些能力,这个项目就是为此设计的:
22+
23+
- Python repository analysis for AI coding assistants
24+
- Generate Cursor rules / Codex `AGENTS.md` / Claude Code docs from source code
25+
- Turn a backend repository into reusable AI skills instead of one-off prompts
26+
- Keep AI repo knowledge incrementally updated in CI
27+
28+
## 为什么它更适合 AI 消费
29+
30+
- 先做结构扫描,再做 Skill 规划,最后生成可复用文档,而不是一次性长 prompt
31+
- Phase 1 不依赖 LLM,先把目录、import、角色、模式、规则和流程提纯
32+
- 输出是稳定文件,不是聊天记录,后续可以直接复用、提交和增量更新
33+
- 支持把生成结果落到不同 IDE/Agent 约定位置,而不是手动复制粘贴
34+
35+
## 你会得到什么
36+
37+
- `project-summary.md`:面向人快速浏览的项目概览
38+
- `skill-blueprint.json`:Phase 1 的结构化仓库蓝图
39+
- `skill-plan.json`:LLM 规划出的 Skill 列表和阅读文件
40+
- `skills/index.md`:Skill 索引
41+
- `skills/*.md`:真正给 AI 编程助手消费的领域规则文档
42+
- `AGENTS.md` / `CLAUDE.md` / `.cursor/rules/*`:适配后的 IDE 产物
43+
44+
## 典型使用场景
745

8-
它的目标不是“总结仓库”,而是生成能直接用于后续编码、审查和增量更新的高密度上下文。
46+
- 给一个已有 Python 后端仓库补齐 Cursor / Codex / Claude Code 规则
47+
- 在 CI 里根据 diff 自动重建受影响的 Skill
48+
- 给团队沉淀一套来自真实代码而不是口头约定的开发规范
49+
- 给 AI 编程工具提供 grounded repository context,减少幻觉和误判
950

1051
## 适用范围
1152

docs/releases/v0.1.3.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# code2skill v0.1.3
2+
3+
## Summary
4+
5+
This release improves public-facing positioning and package metadata while keeping the verified `0.1.x` workflow intact.
6+
7+
It is mainly a documentation and discoverability release built on top of the already validated `0.1.2` pipeline.
8+
9+
## Highlights
10+
11+
- Improved README positioning for GitHub and PyPI readers
12+
- Clearer messaging around what `code2skill` produces and who it is for
13+
- Stronger top-level keywords for AI coding assistant, repository analysis, Cursor, Codex, and Claude Code use cases
14+
- Added a release note artifact into the repository for future releases
15+
16+
## What code2skill does
17+
18+
`code2skill` turns a real Python repository into:
19+
20+
- structured repository summaries
21+
- planned AI skills
22+
- generated `skills/*.md`
23+
- IDE-ready rule files such as `AGENTS.md`, `CLAUDE.md`, and Cursor rules
24+
25+
It is designed for Cursor, Claude Code, Codex, GitHub Copilot, and Windsurf.
26+
27+
## Already validated in the 0.1.x line
28+
29+
- Python AST-based Phase 1 scanning
30+
- import graph construction and scoring improvements
31+
- incremental CI regeneration
32+
- stale skill cleanup during regeneration
33+
- grounded code snippet validation in generated skills
34+
- Qwen default model switched to `qwen-plus-latest`
35+
36+
## Upgrade
37+
38+
```bash
39+
pip install --upgrade code2skill
40+
```
41+
42+
## Notes
43+
44+
- This release focuses on discoverability and clearer communication.
45+
- The underlying package flow remains the same as the tested `0.1.2` release path.

pyproject.toml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "code2skill"
7-
version = "0.1.2"
8-
description = "Turn a code repository into structured AI skill context."
7+
version = "0.1.3"
8+
description = "Generate grounded AI coding assistant skills and repository blueprints from real Python codebases."
99
readme = "README.md"
1010
requires-python = ">=3.10"
1111
license = "Apache-2.0"
@@ -16,7 +16,7 @@ authors = [
1616
dependencies = [
1717
"tomli>=2.0.1; python_version < '3.11'",
1818
]
19-
keywords = ["ai", "cli", "developer-tools", "skills"]
19+
keywords = ["ai", "python", "repository-analysis", "skills", "codex", "cursor", "claude-code", "copilot"]
2020
classifiers = [
2121
"Development Status :: 3 - Alpha",
2222
"Environment :: Console",
@@ -28,6 +28,7 @@ classifiers = [
2828
"Programming Language :: Python :: 3.11",
2929
"Programming Language :: Python :: 3.12",
3030
"Topic :: Software Development :: Build Tools",
31+
"Topic :: Utilities",
3132
"Topic :: Software Development :: Libraries :: Python Modules",
3233
]
3334

src/code2skill/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
from typing import TYPE_CHECKING, Any
66

7-
__version__ = "0.1.2"
7+
__version__ = "0.1.3"
88

99
__all__ = [
1010
"ScanExecution",

0 commit comments

Comments
 (0)