gitcode-insight 0.1.0__tar.gz → 0.1.1__tar.gz

{gitcode_insight-0.1.0/src/gitcode_insight.egg-info → gitcode_insight-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitcode-insight
-Version: 0.1.0
+Version: 0.1.1
 Summary: GitCode 平台代码洞察工具
 Author: GitCode Insight Team
 License-Expression: MIT
@@ -28,9 +28,12 @@ Dynamic: license-file
 
 [![Python Version](https://img.shields.io/badge/python-3.7%2B-blue.svg)](https://www.python.org/downloads/)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/gitcode-insight.svg)](https://pypi.org/project/gitcode-insight/)
 
 GitCode 平台代码洞察命令行工具，支持社区洞察、Issue/PR 分析、仓库统计，生成可视化报告。
 
+**PyPI**: https://pypi.org/project/gitcode-insight/
+
 ## 功能
 
 | 功能 | 说明 |
@@ -43,28 +46,47 @@ GitCode 平台代码洞察命令行工具，支持社区洞察、Issue/PR 分析
 
 ## 快速开始
 
+### 从 PyPI 安装
+
 ```bash
-# 安装
 pip install gitcode-insight
+```
 
-# 或从源码安装
+### 从源码安装（推荐开发使用）
+
+```bash
+# 克隆仓库
 git clone https://gitcode.com/gitcode-cli/insight.git
 cd insight
+
+# 创建虚拟环境
 python3 -m venv .venv
-.venv/bin/pip install -e ".[test]"
+
+# 激活虚拟环境
+# Linux/macOS:
+source .venv/bin/activate
+# Windows:
+# .venv\Scripts\activate
+
+# 安装（开发模式，包含测试依赖）
+pip install -e ".[test]"
 
 # 创建配置文件
 cp config/gitcode.json.example config/gitcode.json
 # 编辑配置文件，填入 access_token 和 owner
+```
 
+### 使用示例
+
+```bash
 # 生成社区看板
 gc-insight dashboard
 
 # 分析单个仓库
-gc-insight issue --repo your-repo --token your_token --days 30
-gc-insight pr --repo your-repo --token your_token --days 30
-gc-insight repo-stats --repo your-repo --token your_token --days 30
-gc-insight report --repo your-repo --token your_token --days 30
+gc-insight issue --repo kernel --owner openeuler --token your_token --days 7
+gc-insight pr --repo kernel --owner openeuler --token your_token --days 7
+gc-insight repo-stats --repo kernel --owner openeuler --token your_token --days 7
+gc-insight report --repo kernel --owner openeuler --token your_token --days 7
 ```
 
 ## 配置
@@ -74,12 +96,46 @@ gc-insight report --repo your-repo --token your_token --days 30
 ```json
 {
     "access_token": "your_gitcode_access_token",
-    "owner": "your_organization_name"
+    "owner": "your_organization_name",
+    "repo_whitelist": ["repo1", "repo2"],
+    "repo_blacklist": ["repo3", "repo4"]
 }
 ```
 
+| 字段 | 说明 |
+|------|------|
+| `access_token` | GitCode API 访问令牌（必填） |
+| `owner` | 组织/社区名称（必填） |
+| `repo_whitelist` | 仓库白名单，仅统计指定仓库 |
+| `repo_blacklist` | 仓库黑名单，排除指定仓库 |
+
 获取 Access Token：GitCode → 设置 → 访问令牌 → 创建新令牌
 
+## 输出产物
+
+所有命令执行后生成三种标准产物，保存在 `./output/` 目录：
+
+| 格式 | 说明 | 用途 |
+|------|------|------|
+| `.json` | 原始数据 + 统计计算数据 | 数据存档、二次开发 |
+| `.md` | Markdown 格式总结报告 | 文档集成、Git 提交 |
+| `.html` | HTML 格式可视化报告 | 浏览器查看、分享展示 |
+
+**示例**：
+
+```
+output/
+├── issue_insight_kvrocks_30d.json    # Issue 数据
+├── issue_insight_kvrocks_30d.md      # Issue Markdown 报告
+├── issue_insight_kvrocks_30d.html    # Issue 可视化报告
+├── pr_insight_kvrocks_30d.json
+├── pr_insight_kvrocks_30d.md
+├── pr_insight_kvrocks_30d.html
+├── report_openeuler_kernel_30d.json
+├── report_openeuler_kernel_30d.md
+└── report_openeuler_kernel_30d.html
+```
+
 ## 常见问题
 
 **Q: 输出文件在哪里？**
@@ -91,11 +147,27 @@ A: GitCode API 每分钟限制 100 次请求，工具已内置限流处理。如
 **Q: CSV 文件中文乱码？**
 A: 文件使用 UTF-8-BOM 编码，Excel 可正常打开。
 
+**Q: 安装时报错 `externally-managed-environment`？**
+A: 这是 Debian/Ubuntu 系统（Python 3.11+）的保护机制，防止破坏系统 Python 环境。请使用虚拟环境安装：
+
+```bash
+# 创建虚拟环境
+python3 -m venv .venv
+
+# 激活虚拟环境
+source .venv/bin/activate  # Linux/macOS
+# .venv\Scripts\activate   # Windows
+
+# 安装
+pip install gitcode-insight
+```
+
 ## 文档
 
 - [用户指南](doc/user_guide.md) - 详细的安装配置和命令说明
 - [开发指南](doc/development.md) - 本地开发和测试
 - [贡献指南](CONTRIBUTING.md) - 参与项目贡献
+- [发布流程](doc/release.md) - PyPI 发布说明
 - [API 文档](doc/gitcode_api/) - GitCode API 接口说明
 
 ## 许可证

gitcode_insight-0.1.1/README.md

@@ -0,0 +1,149 @@
+# GitCode Insight
+
+[![Python Version](https://img.shields.io/badge/python-3.7%2B-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/gitcode-insight.svg)](https://pypi.org/project/gitcode-insight/)
+
+GitCode 平台代码洞察命令行工具，支持社区洞察、Issue/PR 分析、仓库统计，生成可视化报告。
+
+**PyPI**: https://pypi.org/project/gitcode-insight/
+
+## 功能
+
+| 功能 | 说明 |
+|------|------|
+| 社区洞察 | 分析组织下所有仓库的统计数据，生成看板 |
+| Issue 洞察 | Issue 数量、响应时间、关闭率、标签分布 |
+| PR 洞察 | 评审效率、合并耗时、变更规模、冲突率 |
+| 仓库统计 | 下载量、Fork、订阅用户、编程语言 |
+| 综合报告 | 整合所有模块的一站式报告 |
+
+## 快速开始
+
+### 从 PyPI 安装
+
+```bash
+pip install gitcode-insight
+```
+
+### 从源码安装（推荐开发使用）
+
+```bash
+# 克隆仓库
+git clone https://gitcode.com/gitcode-cli/insight.git
+cd insight
+
+# 创建虚拟环境
+python3 -m venv .venv
+
+# 激活虚拟环境
+# Linux/macOS:
+source .venv/bin/activate
+# Windows:
+# .venv\Scripts\activate
+
+# 安装（开发模式，包含测试依赖）
+pip install -e ".[test]"
+
+# 创建配置文件
+cp config/gitcode.json.example config/gitcode.json
+# 编辑配置文件，填入 access_token 和 owner
+```
+
+### 使用示例
+
+```bash
+# 生成社区看板
+gc-insight dashboard
+
+# 分析单个仓库
+gc-insight issue --repo kernel --owner openeuler --token your_token --days 7
+gc-insight pr --repo kernel --owner openeuler --token your_token --days 7
+gc-insight repo-stats --repo kernel --owner openeuler --token your_token --days 7
+gc-insight report --repo kernel --owner openeuler --token your_token --days 7
+```
+
+## 配置
+
+配置文件 `config/gitcode.json`：
+
+```json
+{
+    "access_token": "your_gitcode_access_token",
+    "owner": "your_organization_name",
+    "repo_whitelist": ["repo1", "repo2"],
+    "repo_blacklist": ["repo3", "repo4"]
+}
+```
+
+| 字段 | 说明 |
+|------|------|
+| `access_token` | GitCode API 访问令牌（必填） |
+| `owner` | 组织/社区名称（必填） |
+| `repo_whitelist` | 仓库白名单，仅统计指定仓库 |
+| `repo_blacklist` | 仓库黑名单，排除指定仓库 |
+
+获取 Access Token：GitCode → 设置 → 访问令牌 → 创建新令牌
+
+## 输出产物
+
+所有命令执行后生成三种标准产物，保存在 `./output/` 目录：
+
+| 格式 | 说明 | 用途 |
+|------|------|------|
+| `.json` | 原始数据 + 统计计算数据 | 数据存档、二次开发 |
+| `.md` | Markdown 格式总结报告 | 文档集成、Git 提交 |
+| `.html` | HTML 格式可视化报告 | 浏览器查看、分享展示 |
+
+**示例**：
+
+```
+output/
+├── issue_insight_kvrocks_30d.json    # Issue 数据
+├── issue_insight_kvrocks_30d.md      # Issue Markdown 报告
+├── issue_insight_kvrocks_30d.html    # Issue 可视化报告
+├── pr_insight_kvrocks_30d.json
+├── pr_insight_kvrocks_30d.md
+├── pr_insight_kvrocks_30d.html
+├── report_openeuler_kernel_30d.json
+├── report_openeuler_kernel_30d.md
+└── report_openeuler_kernel_30d.html
+```
+
+## 常见问题
+
+**Q: 输出文件在哪里？**
+A: 默认保存在 `./output/` 目录。
+
+**Q: 请求频繁失败怎么办？**
+A: GitCode API 每分钟限制 100 次请求，工具已内置限流处理。如遇问题，等待几分钟后重试。
+
+**Q: CSV 文件中文乱码？**
+A: 文件使用 UTF-8-BOM 编码，Excel 可正常打开。
+
+**Q: 安装时报错 `externally-managed-environment`？**
+A: 这是 Debian/Ubuntu 系统（Python 3.11+）的保护机制，防止破坏系统 Python 环境。请使用虚拟环境安装：
+
+```bash
+# 创建虚拟环境
+python3 -m venv .venv
+
+# 激活虚拟环境
+source .venv/bin/activate  # Linux/macOS
+# .venv\Scripts\activate   # Windows
+
+# 安装
+pip install gitcode-insight
+```
+
+## 文档
+
+- [用户指南](doc/user_guide.md) - 详细的安装配置和命令说明
+- [开发指南](doc/development.md) - 本地开发和测试
+- [贡献指南](CONTRIBUTING.md) - 参与项目贡献
+- [发布流程](doc/release.md) - PyPI 发布说明
+- [API 文档](doc/gitcode_api/) - GitCode API 接口说明
+
+## 许可证
+
+[MIT License](LICENSE)

{gitcode_insight-0.1.0 → gitcode_insight-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gitcode-insight"
-version = "0.1.0"
+version = "0.1.1"
 description = "GitCode 平台代码洞察工具"
 readme = "README.md"
 license = "MIT"

{gitcode_insight-0.1.0 → gitcode_insight-0.1.1}/src/gitcode_insight/__init__.py

@@ -3,7 +3,7 @@
 GitCode Insight - GitCode 平台代码洞察工具
 """
 
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 __author__ = "GitCode Insight Team"
 
 from .community import GitCodeCommunityStats

{gitcode_insight-0.1.0 → gitcode_insight-0.1.1}/src/gitcode_insight/cli.py

@@ -5,7 +5,6 @@ GitCode Insight 命令行入口
 
 import argparse
 import os
-import json
 
 from .community import GitCodeCommunityStats
 from .issue import GitCodeIssueInsight
@@ -13,6 +12,7 @@ from .pr import GitCodePRInsight
 from .dashboard import generate_dashboard
 from .repo_stats import GitCodeRepoStats
 from .report import GitCodeReport
+from .utils import load_config
 
 
 def get_config_owner(config_file):
@@ -20,11 +20,11 @@ def get_config_owner(config_file):
     if config_file is None:
         config_file = os.path.join(os.getcwd(), "config", "gitcode.json")
 
-    if os.path.exists(config_file):
-        with open(config_file, 'r', encoding='utf-8') as f:
-            config = json.load(f)
-            return config.get("owner", "")
-    return ""
+    try:
+        config = load_config(config_file)
+        return config.get("owner", "")
+    except SystemExit:
+        return ""
 
 
 def cmd_community(args):

{gitcode_insight-0.1.0 → gitcode_insight-0.1.1}/src/gitcode_insight/community.py

@@ -12,7 +12,7 @@ import csv
 import os
 import requests
 
-from .utils import request_with_retry
+from .utils import request_with_retry, load_config
 
 
 class GitCodeCommunityStats:
@@ -36,9 +36,8 @@ class GitCodeCommunityStats:
 
         self.output_dir = output_dir
 
-        # 读取配置文件
-        with open(config_file, 'r', encoding='utf-8') as f:
-            config = json.load(f)
+        # 读取并验证配置文件
+        config = load_config(config_file)
 
         self.base_url = "https://api.gitcode.com/api/v5"
         self.headers = {

{gitcode_insight-0.1.0 → gitcode_insight-0.1.1}/src/gitcode_insight/utils.py

@@ -4,11 +4,62 @@
 提供统一的请求重试、限流处理等功能
 """
 
+import json
+import os
+import sys
 import time
 from typing import Optional, Dict, Any
 import requests
 
 
+def load_config(config_file: str) -> dict:
+    """
+    加载并验证配置文件
+
+    Args:
+        config_file: 配置文件路径
+
+    Returns:
+        配置字典
+
+    Raises:
+        SystemExit: 配置文件不存在、格式错误或必填项缺失时退出程序
+    """
+    # 检查配置文件是否存在
+    if not os.path.exists(config_file):
+        print(f"错误: 配置文件不存在")
+        print(f"  路径: {config_file}")
+        print(f"  请创建配置文件: cp config/gitcode.json.example config/gitcode.json")
+        sys.exit(1)
+
+    # 尝试解析 JSON 文件
+    try:
+        with open(config_file, 'r', encoding='utf-8') as f:
+            config = json.load(f)
+    except json.JSONDecodeError as e:
+        print(f"错误: 配置文件格式错误")
+        print(f"  路径: {config_file}")
+        print(f"  详情: {e}")
+        sys.exit(1)
+    except Exception as e:
+        print(f"错误: 无法读取配置文件")
+        print(f"  路径: {config_file}")
+        print(f"  详情: {e}")
+        sys.exit(1)
+
+    # 验证必填项
+    required_fields = ["access_token", "owner"]
+    missing_fields = [field for field in required_fields if not config.get(field)]
+
+    if missing_fields:
+        print(f"错误: 配置文件缺少必填项")
+        print(f"  路径: {config_file}")
+        print(f"  缺失字段: {', '.join(missing_fields)}")
+        sys.exit(1)
+
+    return config
+
+
 def request_with_retry(
     session: requests.Session,
     url: str,

{gitcode_insight-0.1.0 → gitcode_insight-0.1.1/src/gitcode_insight.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitcode-insight
-Version: 0.1.0
+Version: 0.1.1
 Summary: GitCode 平台代码洞察工具
 Author: GitCode Insight Team
 License-Expression: MIT
@@ -28,9 +28,12 @@ Dynamic: license-file
 
 [![Python Version](https://img.shields.io/badge/python-3.7%2B-blue.svg)](https://www.python.org/downloads/)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/gitcode-insight.svg)](https://pypi.org/project/gitcode-insight/)
 
 GitCode 平台代码洞察命令行工具，支持社区洞察、Issue/PR 分析、仓库统计，生成可视化报告。
 
+**PyPI**: https://pypi.org/project/gitcode-insight/
+
 ## 功能
 
 | 功能 | 说明 |
@@ -43,28 +46,47 @@ GitCode 平台代码洞察命令行工具，支持社区洞察、Issue/PR 分析
 
 ## 快速开始
 
+### 从 PyPI 安装
+
 ```bash
-# 安装
 pip install gitcode-insight
+```
 
-# 或从源码安装
+### 从源码安装（推荐开发使用）
+
+```bash
+# 克隆仓库
 git clone https://gitcode.com/gitcode-cli/insight.git
 cd insight
+
+# 创建虚拟环境
 python3 -m venv .venv
-.venv/bin/pip install -e ".[test]"
+
+# 激活虚拟环境
+# Linux/macOS:
+source .venv/bin/activate
+# Windows:
+# .venv\Scripts\activate
+
+# 安装（开发模式，包含测试依赖）
+pip install -e ".[test]"
 
 # 创建配置文件
 cp config/gitcode.json.example config/gitcode.json
 # 编辑配置文件，填入 access_token 和 owner
+```
 
+### 使用示例
+
+```bash
 # 生成社区看板
 gc-insight dashboard
 
 # 分析单个仓库
-gc-insight issue --repo your-repo --token your_token --days 30
-gc-insight pr --repo your-repo --token your_token --days 30
-gc-insight repo-stats --repo your-repo --token your_token --days 30
-gc-insight report --repo your-repo --token your_token --days 30
+gc-insight issue --repo kernel --owner openeuler --token your_token --days 7
+gc-insight pr --repo kernel --owner openeuler --token your_token --days 7
+gc-insight repo-stats --repo kernel --owner openeuler --token your_token --days 7
+gc-insight report --repo kernel --owner openeuler --token your_token --days 7
 ```
 
 ## 配置
@@ -74,12 +96,46 @@ gc-insight report --repo your-repo --token your_token --days 30
 ```json
 {
     "access_token": "your_gitcode_access_token",
-    "owner": "your_organization_name"
+    "owner": "your_organization_name",
+    "repo_whitelist": ["repo1", "repo2"],
+    "repo_blacklist": ["repo3", "repo4"]
 }
 ```
 
+| 字段 | 说明 |
+|------|------|
+| `access_token` | GitCode API 访问令牌（必填） |
+| `owner` | 组织/社区名称（必填） |
+| `repo_whitelist` | 仓库白名单，仅统计指定仓库 |
+| `repo_blacklist` | 仓库黑名单，排除指定仓库 |
+
 获取 Access Token：GitCode → 设置 → 访问令牌 → 创建新令牌
 
+## 输出产物
+
+所有命令执行后生成三种标准产物，保存在 `./output/` 目录：
+
+| 格式 | 说明 | 用途 |
+|------|------|------|
+| `.json` | 原始数据 + 统计计算数据 | 数据存档、二次开发 |
+| `.md` | Markdown 格式总结报告 | 文档集成、Git 提交 |
+| `.html` | HTML 格式可视化报告 | 浏览器查看、分享展示 |
+
+**示例**：
+
+```
+output/
+├── issue_insight_kvrocks_30d.json    # Issue 数据
+├── issue_insight_kvrocks_30d.md      # Issue Markdown 报告
+├── issue_insight_kvrocks_30d.html    # Issue 可视化报告
+├── pr_insight_kvrocks_30d.json
+├── pr_insight_kvrocks_30d.md
+├── pr_insight_kvrocks_30d.html
+├── report_openeuler_kernel_30d.json
+├── report_openeuler_kernel_30d.md
+└── report_openeuler_kernel_30d.html
+```
+
 ## 常见问题
 
 **Q: 输出文件在哪里？**
@@ -91,11 +147,27 @@ A: GitCode API 每分钟限制 100 次请求，工具已内置限流处理。如
 **Q: CSV 文件中文乱码？**
 A: 文件使用 UTF-8-BOM 编码，Excel 可正常打开。
 
+**Q: 安装时报错 `externally-managed-environment`？**
+A: 这是 Debian/Ubuntu 系统（Python 3.11+）的保护机制，防止破坏系统 Python 环境。请使用虚拟环境安装：
+
+```bash
+# 创建虚拟环境
+python3 -m venv .venv
+
+# 激活虚拟环境
+source .venv/bin/activate  # Linux/macOS
+# .venv\Scripts\activate   # Windows
+
+# 安装
+pip install gitcode-insight
+```
+
 ## 文档
 
 - [用户指南](doc/user_guide.md) - 详细的安装配置和命令说明
 - [开发指南](doc/development.md) - 本地开发和测试
 - [贡献指南](CONTRIBUTING.md) - 参与项目贡献
+- [发布流程](doc/release.md) - PyPI 发布说明
 - [API 文档](doc/gitcode_api/) - GitCode API 接口说明
 
 ## 许可证

gitcode_insight-0.1.0/README.md

@@ -1,77 +0,0 @@
-# GitCode Insight
-
-[![Python Version](https://img.shields.io/badge/python-3.7%2B-blue.svg)](https://www.python.org/downloads/)
-[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
-
-GitCode 平台代码洞察命令行工具，支持社区洞察、Issue/PR 分析、仓库统计，生成可视化报告。
-
-## 功能
-
-| 功能 | 说明 |
-|------|------|
-| 社区洞察 | 分析组织下所有仓库的统计数据，生成看板 |
-| Issue 洞察 | Issue 数量、响应时间、关闭率、标签分布 |
-| PR 洞察 | 评审效率、合并耗时、变更规模、冲突率 |
-| 仓库统计 | 下载量、Fork、订阅用户、编程语言 |
-| 综合报告 | 整合所有模块的一站式报告 |
-
-## 快速开始
-
-```bash
-# 安装
-pip install gitcode-insight
-
-# 或从源码安装
-git clone https://gitcode.com/gitcode-cli/insight.git
-cd insight
-python3 -m venv .venv
-.venv/bin/pip install -e ".[test]"
-
-# 创建配置文件
-cp config/gitcode.json.example config/gitcode.json
-# 编辑配置文件，填入 access_token 和 owner
-
-# 生成社区看板
-gc-insight dashboard
-
-# 分析单个仓库
-gc-insight issue --repo your-repo --token your_token --days 30
-gc-insight pr --repo your-repo --token your_token --days 30
-gc-insight repo-stats --repo your-repo --token your_token --days 30
-gc-insight report --repo your-repo --token your_token --days 30
-```
-
-## 配置
-
-配置文件 `config/gitcode.json`：
-
-```json
-{
-    "access_token": "your_gitcode_access_token",
-    "owner": "your_organization_name"
-}
-```
-
-获取 Access Token：GitCode → 设置 → 访问令牌 → 创建新令牌
-
-## 常见问题
-
-**Q: 输出文件在哪里？**
-A: 默认保存在 `./output/` 目录。
-
-**Q: 请求频繁失败怎么办？**
-A: GitCode API 每分钟限制 100 次请求，工具已内置限流处理。如遇问题，等待几分钟后重试。
-
-**Q: CSV 文件中文乱码？**
-A: 文件使用 UTF-8-BOM 编码，Excel 可正常打开。
-
-## 文档
-
-- [用户指南](doc/user_guide.md) - 详细的安装配置和命令说明
-- [开发指南](doc/development.md) - 本地开发和测试
-- [贡献指南](CONTRIBUTING.md) - 参与项目贡献
-- [API 文档](doc/gitcode_api/) - GitCode API 接口说明
-
-## 许可证
-
-[MIT License](LICENSE)