git-analytics-cli 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Git Analytics Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,3 @@
1
+ include share-card.html
2
+ include LICENSE
3
+ include README.md
@@ -0,0 +1,175 @@
1
+ Metadata-Version: 2.4
2
+ Name: git-analytics-cli
3
+ Version: 0.1.0
4
+ Summary: Local-first Git habit analytics — scan your repos, get a developer persona and health report
5
+ Author: Git Analytics Contributors
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/mark-618/git-analytics
8
+ Project-URL: Repository, https://github.com/mark-618/git-analytics
9
+ Project-URL: Issues, https://github.com/mark-618/git-analytics/issues
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Environment :: Console
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.8
16
+ Classifier: Programming Language :: Python :: 3.9
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Programming Language :: Python :: 3.13
21
+ Classifier: Topic :: Software Development :: Version Control :: Git
22
+ Requires-Python: >=3.8
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ Provides-Extra: share-card
26
+ Requires-Dist: Pillow>=8.0; extra == "share-card"
27
+ Dynamic: license-file
28
+
29
+ # Git Analytics
30
+
31
+ **扫描本地 Git 仓库,生成你的开发者人格画像和代码习惯体检报告。**
32
+
33
+ 不只统计 commits 和 lines——它告诉你:你是什么类型的开发者,你的代码习惯健康吗。
34
+
35
+ ## 安装
36
+
37
+ ```bash
38
+ pip install git-analytics
39
+ ```
40
+
41
+ 如需生成 PNG 分享卡片(可选,需要 Pillow):
42
+
43
+ ```bash
44
+ pip install git-analytics[share-card]
45
+ ```
46
+
47
+ ## 30 秒快速开始
48
+
49
+ ```bash
50
+ # 运行交互式向导,选目录、选参数,一键出报告
51
+ git-analytics
52
+
53
+ # 或者直接指定扫描目录
54
+ git-analytics ~/Projects
55
+ ```
56
+
57
+ 向导会引导你选择扫描目录、扫描深度、输出目录等,不需要记任何参数。
58
+
59
+ ## CLI 用法
60
+
61
+ ```bash
62
+ # 交互式向导(默认)
63
+ git-analytics
64
+
65
+ # 扫描指定目录
66
+ git-analytics ~/Projects
67
+
68
+ # 同时扫描多个目录
69
+ git-analytics ~/Projects ~/Work ~/Side-projects
70
+
71
+ # 关闭向导,适合脚本 / CI
72
+ git-analytics --no-wizard
73
+
74
+ # 指定输出目录 + 自动打开报告 + 生成分享卡片设计器
75
+ git-analytics ~/Projects --output-dir ./out --open --share-card
76
+
77
+ # 限定时间范围
78
+ git-analytics ~/Projects --since 2024-01-01 --until 2024-12-31
79
+
80
+ # 只分析特定项目(模糊匹配)
81
+ git-analytics ~/Projects --project my-app
82
+
83
+ # 增加扫描深度(默认 3)
84
+ git-analytics ~/Projects --max-depth 5
85
+ ```
86
+
87
+ ### 参数一览
88
+
89
+ | 参数 | 说明 |
90
+ |------|------|
91
+ | `scan_dir` | 扫描目录,可传多个(默认当前目录) |
92
+ | `--no-wizard` | 关闭交互式向导 |
93
+ | `--output-dir` | 输出目录(默认当前目录) |
94
+ | `--max-depth` | 扫描目录深度(默认 3) |
95
+ | `--since` / `--until` | 时间范围过滤 |
96
+ | `--project` | 只分析指定项目(模糊匹配) |
97
+ | `--open` | 生成后自动打开报告 |
98
+ | `--share-card` | 同时输出分享卡片设计器 HTML |
99
+
100
+ ## 输出文件
101
+
102
+ | 文件 | 说明 |
103
+ |------|------|
104
+ | `report.html` | 代码习惯体检报告,用浏览器打开 |
105
+ | `data.json` | 原始分析数据(JSON) |
106
+ | `share-card.html` | 分享卡片设计器(使用 `--share-card` 时生成) |
107
+
108
+ ## 它分析什么
109
+
110
+ - **开发者人格**:6 维度光谱分类(时间偏好、节奏风格、专注程度、开发风格、工程取向、AI 协作)
111
+ - **习惯健康分**:0-100 分,覆盖提交粒度、测试意识、文档意识、作息规律、项目聚焦度
112
+ - **时间习惯**:24 小时热力图、最活跃时段、周末工作指数
113
+ - **工程健康**:测试覆盖、文档投入、commit 类型分布、低信息量 commit 占比
114
+ - **AI 使用痕迹**:检测 commit 中的 AI 工具信号(Claude、Copilot、Cursor 等)
115
+ - **项目聚焦度**:Top 3 项目占比、多项目切换分析
116
+
117
+ ## 本地隐私
118
+
119
+ - **完全本地运行**,不上传任何代码或数据
120
+ - 不需要 GitHub Token
121
+ - 可分析私有项目、实验项目、未发布项目
122
+ - 所有数据只存在你的电脑上
123
+
124
+ ## 分享卡片
125
+
126
+ 使用 `--share-card` 生成一个 HTML 设计器,可以在浏览器中:
127
+
128
+ - 预览你的开发者画像卡片
129
+ - 选择配色主题
130
+ - 导出 PNG 图片用于社交分享
131
+
132
+ ## 为什么不是全盘扫描
133
+
134
+ 默认只扫描你指定的目录,不会遍历整个磁盘。原因:
135
+
136
+ 1. 安全:避免意外扫描包含敏感数据的目录
137
+ 2. 性能:全盘扫描耗时太长
138
+ 3. 聚焦:你只关心自己的项目目录
139
+
140
+ ## FAQ
141
+
142
+ ### 扫描不到仓库?
143
+
144
+ - 确认目录下有 `.git` 文件夹
145
+ - 增加 `--max-depth`(默认 3,可以试 5)
146
+ - 检查目录路径是否正确
147
+
148
+ ### 报告打不开?
149
+
150
+ - 用浏览器直接打开 `report.html` 文件
151
+ - 确保文件有读取权限
152
+ - 检查文件大小是否为 0(可能扫描没找到数据)
153
+
154
+ ### 如何扫多个目录?
155
+
156
+ ```bash
157
+ git-analytics ~/Projects ~/Work ~/Code
158
+ ```
159
+
160
+ 多个目录直接用空格分隔。
161
+
162
+ ### 和 GitStats 有什么区别?
163
+
164
+ GitStats 告诉你一个仓库发生了什么;Git Analytics 告诉你你是一个什么样的开发者。
165
+
166
+ ## 技术栈
167
+
168
+ - Python 3.8+
169
+ - 零运行时依赖(纯标准库)
170
+ - Chart.js 可视化报告
171
+ - 本地运行
172
+
173
+ ## License
174
+
175
+ MIT
@@ -0,0 +1,147 @@
1
+ # Git Analytics
2
+
3
+ **扫描本地 Git 仓库,生成你的开发者人格画像和代码习惯体检报告。**
4
+
5
+ 不只统计 commits 和 lines——它告诉你:你是什么类型的开发者,你的代码习惯健康吗。
6
+
7
+ ## 安装
8
+
9
+ ```bash
10
+ pip install git-analytics
11
+ ```
12
+
13
+ 如需生成 PNG 分享卡片(可选,需要 Pillow):
14
+
15
+ ```bash
16
+ pip install git-analytics[share-card]
17
+ ```
18
+
19
+ ## 30 秒快速开始
20
+
21
+ ```bash
22
+ # 运行交互式向导,选目录、选参数,一键出报告
23
+ git-analytics
24
+
25
+ # 或者直接指定扫描目录
26
+ git-analytics ~/Projects
27
+ ```
28
+
29
+ 向导会引导你选择扫描目录、扫描深度、输出目录等,不需要记任何参数。
30
+
31
+ ## CLI 用法
32
+
33
+ ```bash
34
+ # 交互式向导(默认)
35
+ git-analytics
36
+
37
+ # 扫描指定目录
38
+ git-analytics ~/Projects
39
+
40
+ # 同时扫描多个目录
41
+ git-analytics ~/Projects ~/Work ~/Side-projects
42
+
43
+ # 关闭向导,适合脚本 / CI
44
+ git-analytics --no-wizard
45
+
46
+ # 指定输出目录 + 自动打开报告 + 生成分享卡片设计器
47
+ git-analytics ~/Projects --output-dir ./out --open --share-card
48
+
49
+ # 限定时间范围
50
+ git-analytics ~/Projects --since 2024-01-01 --until 2024-12-31
51
+
52
+ # 只分析特定项目(模糊匹配)
53
+ git-analytics ~/Projects --project my-app
54
+
55
+ # 增加扫描深度(默认 3)
56
+ git-analytics ~/Projects --max-depth 5
57
+ ```
58
+
59
+ ### 参数一览
60
+
61
+ | 参数 | 说明 |
62
+ |------|------|
63
+ | `scan_dir` | 扫描目录,可传多个(默认当前目录) |
64
+ | `--no-wizard` | 关闭交互式向导 |
65
+ | `--output-dir` | 输出目录(默认当前目录) |
66
+ | `--max-depth` | 扫描目录深度(默认 3) |
67
+ | `--since` / `--until` | 时间范围过滤 |
68
+ | `--project` | 只分析指定项目(模糊匹配) |
69
+ | `--open` | 生成后自动打开报告 |
70
+ | `--share-card` | 同时输出分享卡片设计器 HTML |
71
+
72
+ ## 输出文件
73
+
74
+ | 文件 | 说明 |
75
+ |------|------|
76
+ | `report.html` | 代码习惯体检报告,用浏览器打开 |
77
+ | `data.json` | 原始分析数据(JSON) |
78
+ | `share-card.html` | 分享卡片设计器(使用 `--share-card` 时生成) |
79
+
80
+ ## 它分析什么
81
+
82
+ - **开发者人格**:6 维度光谱分类(时间偏好、节奏风格、专注程度、开发风格、工程取向、AI 协作)
83
+ - **习惯健康分**:0-100 分,覆盖提交粒度、测试意识、文档意识、作息规律、项目聚焦度
84
+ - **时间习惯**:24 小时热力图、最活跃时段、周末工作指数
85
+ - **工程健康**:测试覆盖、文档投入、commit 类型分布、低信息量 commit 占比
86
+ - **AI 使用痕迹**:检测 commit 中的 AI 工具信号(Claude、Copilot、Cursor 等)
87
+ - **项目聚焦度**:Top 3 项目占比、多项目切换分析
88
+
89
+ ## 本地隐私
90
+
91
+ - **完全本地运行**,不上传任何代码或数据
92
+ - 不需要 GitHub Token
93
+ - 可分析私有项目、实验项目、未发布项目
94
+ - 所有数据只存在你的电脑上
95
+
96
+ ## 分享卡片
97
+
98
+ 使用 `--share-card` 生成一个 HTML 设计器,可以在浏览器中:
99
+
100
+ - 预览你的开发者画像卡片
101
+ - 选择配色主题
102
+ - 导出 PNG 图片用于社交分享
103
+
104
+ ## 为什么不是全盘扫描
105
+
106
+ 默认只扫描你指定的目录,不会遍历整个磁盘。原因:
107
+
108
+ 1. 安全:避免意外扫描包含敏感数据的目录
109
+ 2. 性能:全盘扫描耗时太长
110
+ 3. 聚焦:你只关心自己的项目目录
111
+
112
+ ## FAQ
113
+
114
+ ### 扫描不到仓库?
115
+
116
+ - 确认目录下有 `.git` 文件夹
117
+ - 增加 `--max-depth`(默认 3,可以试 5)
118
+ - 检查目录路径是否正确
119
+
120
+ ### 报告打不开?
121
+
122
+ - 用浏览器直接打开 `report.html` 文件
123
+ - 确保文件有读取权限
124
+ - 检查文件大小是否为 0(可能扫描没找到数据)
125
+
126
+ ### 如何扫多个目录?
127
+
128
+ ```bash
129
+ git-analytics ~/Projects ~/Work ~/Code
130
+ ```
131
+
132
+ 多个目录直接用空格分隔。
133
+
134
+ ### 和 GitStats 有什么区别?
135
+
136
+ GitStats 告诉你一个仓库发生了什么;Git Analytics 告诉你你是一个什么样的开发者。
137
+
138
+ ## 技术栈
139
+
140
+ - Python 3.8+
141
+ - 零运行时依赖(纯标准库)
142
+ - Chart.js 可视化报告
143
+ - 本地运行
144
+
145
+ ## License
146
+
147
+ MIT