gitcode-insight 0.1.0__tar.gz

gitcode_insight-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 GitCode Insight Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gitcode_insight-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: gitcode-insight
+Version: 0.1.0
+Summary: GitCode 平台代码洞察工具
+Author: GitCode Insight Team
+License-Expression: MIT
+Project-URL: Homepage, https://gitcode.com/gitcode-cli/insight
+Project-URL: Repository, https://gitcode.com/gitcode-cli/insight
+Keywords: gitcode,insight,analytics,dashboard
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Dynamic: license-file
+
+# 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)

gitcode_insight-0.1.0/README.md

@@ -0,0 +1,77 @@
+# 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)

gitcode_insight-0.1.0/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gitcode-insight"
+version = "0.1.0"
+description = "GitCode 平台代码洞察工具"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.7"
+authors = [
+    {name = "GitCode Insight Team"}
+]
+keywords = ["gitcode", "insight", "analytics", "dashboard"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+dependencies = [
+    "requests>=2.25.0",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+]
+
+[project.scripts]
+gc-insight = "gitcode_insight.cli:main"
+
+[project.urls]
+Homepage = "https://gitcode.com/gitcode-cli/insight"
+Repository = "https://gitcode.com/gitcode-cli/insight"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_functions = ["test_*"]
+addopts = "-v --tb=short"
+markers = [
+    "integration: marks tests that require real API access (deselect with '-m \"not integration\"')",
+]

gitcode_insight-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

gitcode_insight-0.1.0/src/gitcode_insight/__init__.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+"""
+GitCode Insight - GitCode 平台代码洞察工具
+"""
+
+__version__ = "0.1.0"
+__author__ = "GitCode Insight Team"
+
+from .community import GitCodeCommunityStats
+from .issue import GitCodeIssueInsight
+from .pr import GitCodePRInsight
+from .dashboard import generate_dashboard, generate_markdown_file
+from .repo_stats import GitCodeRepoStats
+from .report import GitCodeReport
+
+__all__ = [
+    "GitCodeCommunityStats",
+    "GitCodeIssueInsight",
+    "GitCodePRInsight",
+    "generate_dashboard",
+    "generate_markdown_file",
+    "GitCodeRepoStats",
+    "GitCodeReport",
+]

gitcode_insight-0.1.0/src/gitcode_insight/cli.py

@@ -0,0 +1,212 @@
+# -*- coding: utf-8 -*-
+"""
+GitCode Insight 命令行入口
+"""
+
+import argparse
+import os
+import json
+
+from .community import GitCodeCommunityStats
+from .issue import GitCodeIssueInsight
+from .pr import GitCodePRInsight
+from .dashboard import generate_dashboard
+from .repo_stats import GitCodeRepoStats
+from .report import GitCodeReport
+
+
+def get_config_owner(config_file):
+    """从配置文件获取 owner"""
+    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 ""
+
+
+def cmd_community(args):
+    """社区洞察命令"""
+    config_file = args.config
+    output_dir = args.output
+
+    # 创建统计实例
+    stats_crawler = GitCodeCommunityStats(config_file=config_file, output_dir=output_dir)
+
+    # 爬取社区的统计数据
+    stats = stats_crawler.crawl_community_stats()
+
+    # 生成报告
+    stats_crawler.generate_report(stats)
+
+    # 保存到CSV
+    stats_crawler.save_to_csv(stats)
+
+    # 保存详细数据到JSON
+    stats_crawler.save_to_json(stats)
+
+    print("\n\n数据爬取和分析完成！")
+    print("- 详细报告已打印到控制台")
+
+
+def cmd_issue(args):
+    """Issue 洞察命令"""
+    insight = GitCodeIssueInsight(
+        repo=args.repo,
+        token=args.token,
+        owner=args.owner,
+        days=args.days,
+        range_by=args.range_by,
+        output_dir=args.output
+    )
+
+    insight.run()
+
+
+def cmd_pr(args):
+    """PR 洞察命令"""
+    insight = GitCodePRInsight(
+        repo=args.repo,
+        token=args.token,
+        owner=args.owner,
+        days=args.days,
+        output_dir=args.output
+    )
+
+    insight.run()
+
+
+def cmd_repo_stats(args):
+    """仓库统计命令"""
+    stats = GitCodeRepoStats(
+        repo=args.repo,
+        token=args.token,
+        owner=args.owner,
+        days=args.days,
+        output_dir=args.output
+    )
+
+    stats.run()
+
+
+def cmd_dashboard(args):
+    """生成看板命令（自动检测数据是否存在，不存在则先采集）"""
+    config_file = args.config
+    output_dir = args.output
+
+    # 设置默认路径
+    if config_file is None:
+        config_file = os.path.join(os.getcwd(), "config", "gitcode.json")
+    if output_dir is None:
+        output_dir = os.path.join(os.getcwd(), "output")
+
+    # 获取 owner
+    owner = get_config_owner(config_file)
+    if not owner:
+        print("错误: 无法从配置文件获取 owner")
+        return
+
+    # 检测数据文件是否存在
+    json_file = os.path.join(output_dir, f"{owner}_community_stats_detailed.json")
+
+    if not os.path.exists(json_file):
+        print(f"数据文件不存在: {json_file}")
+        print("开始自动采集数据...\n")
+
+        # 自动运行采集
+        stats_crawler = GitCodeCommunityStats(config_file=config_file, output_dir=output_dir)
+        stats = stats_crawler.crawl_community_stats()
+        stats_crawler.generate_report(stats)
+        stats_crawler.save_to_csv(stats)
+        stats_crawler.save_to_json(stats)
+
+        print("\n数据采集完成！\n")
+
+    # 生成看板
+    generate_dashboard(config_file=config_file, output_dir=output_dir)
+
+
+def cmd_report(args):
+    """仓库综合报告命令"""
+    report = GitCodeReport(
+        repo=args.repo,
+        token=args.token,
+        owner=args.owner,
+        days=args.days,
+        output_dir=args.output
+    )
+
+    report.run()
+
+
+def main():
+    """主入口"""
+    parser = argparse.ArgumentParser(
+        prog="gc-insight",
+        description="GitCode 平台代码洞察工具"
+    )
+
+    subparsers = parser.add_subparsers(dest="command", help="子命令")
+
+    # community 子命令
+    community_parser = subparsers.add_parser("community", help="社区洞察")
+    community_parser.add_argument("--config", default=None, help="配置文件路径，默认使用 ./config/gitcode.json")
+    community_parser.add_argument("--output", default=None, help="输出目录，默认使用 ./output/")
+    community_parser.set_defaults(func=cmd_community)
+
+    # issue 子命令
+    issue_parser = subparsers.add_parser("issue", help="Issue 洞察")
+    issue_parser.add_argument("--repo", required=True, help="仓库名称（path）")
+    issue_parser.add_argument("--token", required=True, help="API 访问令牌")
+    issue_parser.add_argument("--days", type=int, default=30, help="统计天数，默认 30")
+    issue_parser.add_argument("--range-by", dest="range_by", choices=["created", "updated", "active"], default="created", help="统计范围口径：created=近N天创建，updated=近N天更新，active=近N天创建或更新（默认 created）")
+    issue_parser.add_argument("--owner", default=None, help="组织名，默认从配置文件读取")
+    issue_parser.add_argument("--output", default=None, help="输出目录，默认使用 ./output/")
+    issue_parser.set_defaults(func=cmd_issue)
+
+    # pr 子命令
+    pr_parser = subparsers.add_parser("pr", help="PR 洞察")
+    pr_parser.add_argument("--repo", required=True, help="仓库名称（path）")
+    pr_parser.add_argument("--token", required=True, help="API 访问令牌")
+    pr_parser.add_argument("--days", type=int, default=30, help="统计天数，默认 30")
+    pr_parser.add_argument("--owner", default=None, help="组织名，默认从配置文件读取")
+    pr_parser.add_argument("--output", default=None, help="输出目录，默认使用 ./output/")
+    pr_parser.set_defaults(func=cmd_pr)
+
+    # repo-stats 子命令
+    repo_stats_parser = subparsers.add_parser("repo-stats", help="仓库统计")
+    repo_stats_parser.add_argument("--repo", required=True, help="仓库名称（path）")
+    repo_stats_parser.add_argument("--token", required=True, help="API 访问令牌")
+    repo_stats_parser.add_argument("--owner", default=None, help="组织名，默认从配置文件读取")
+    repo_stats_parser.add_argument("--days", type=int, default=30, help="统计天数，默认 30")
+    repo_stats_parser.add_argument("--output", default=None, help="输出目录，默认使用 ./output/")
+    repo_stats_parser.set_defaults(func=cmd_repo_stats)
+
+    # dashboard 子命令
+    dashboard_parser = subparsers.add_parser("dashboard", help="生成看板")
+    dashboard_parser.add_argument("--config", default=None, help="配置文件路径，默认使用 ./config/gitcode.json")
+    dashboard_parser.add_argument("--output", default=None, help="输出目录，默认使用 ./output/")
+    dashboard_parser.set_defaults(func=cmd_dashboard)
+
+    # report 子命令
+    report_parser = subparsers.add_parser("report", help="仓库综合报告")
+    report_parser.add_argument("--repo", required=True, help="仓库名称（path）")
+    report_parser.add_argument("--token", required=True, help="API 访问令牌")
+    report_parser.add_argument("--days", type=int, default=30, help="统计天数，默认 30")
+    report_parser.add_argument("--owner", default=None, help="组织名，默认从配置文件读取")
+    report_parser.add_argument("--output", default=None, help="输出目录，默认使用 ./output/")
+    report_parser.set_defaults(func=cmd_report)
+
+    args = parser.parse_args()
+
+    if args.command is None:
+        parser.print_help()
+        return
+
+    args.func(args)
+
+
+if __name__ == "__main__":
+    main()