gitinsight-cli 0.1.0__tar.gz

gitinsight_cli-0.1.0/.github/copilot-instructions.md

@@ -0,0 +1,26 @@
+# 项目速览
+- 这是一个本地 Git 仓库分析工具：`main.py` 负责入口、日志与进度输出；分析链路为 `git_reader.py -> analysis.py -> charts.py -> dashboard.py -> report.py`。
+- 输出物是可视化仪表板 HTML：`git_analysis_<repo_name>.html`，由 `dashboard.py` 拼装图表与 KPI 卡片。
+- Git 日志通过 `git_reader.get_git_log()` 读取，并缓存到 `git_reader.py` 同级的 `.cache/.git_log_<hash>.cache`（默认 1 天有效）。
+
+# 关键数据流与结构
+- `git_reader.parse_git_log()` 产出两个 DataFrame：
+  - `commits_df`：`hash/author/email/datetime_str/message/insertions/deletions`
+  - `file_stats_df`：`hash/filepath/insertions/deletions`
+- `analysis.prepare_dataframe()` 统一处理时区（`Asia/Shanghai`）并添加字段：`local_time/date/date_6am_cutoff/time_in_6am_day`；凌晨提交以 06:00 作为分界。
+- `analysis.filter_automated_commits()` 按 `datetime_str` 以 `+0000` 结尾过滤自动化提交（先过滤后计算指标）。
+- `analysis.compute_insights()` 聚合所有指标并返回给 `dashboard.build_dashboard_html()`，包括 `author_stats`、`monthly_trends`、`daily_commits`、`code_activity`、`code_stability`、`file_heatmap` 等。
+
+# 图表与仪表板约定
+- 图表构建集中在 `charts.py`，仪表板布局 + JS 交互在 `dashboard.py`。
+- `dashboard._render_chart_div()` 会解析 pyecharts 生成的 HTML 片段并嵌入页面；`devData`/雷达图/日历图等开发者面板数据在服务端预计算。
+- ECharts 资源通过 CDN 引入（`https://assets.pyecharts.org/assets/v5/echarts.min.js`）。
+
+# 常用开发/运行方式
+- 依赖由 `pyproject.toml` 管理（`uv sync`）；入口脚本为 `python main.py <git_repo_path>`，或运行后交互输入路径（见 `README.md`）。
+- Windows 控制台编码已在 `main.py` 中处理（`sys.stdout`/`stderr` UTF-8 包装），保持此模式以支持中文/emoji 输出。
+
+# 贡献时的约定与示例
+- 新增指标请在 `analysis.py` 中计算并在 `compute_insights()` 中返回，再在 `charts.py`/`dashboard.py` 中渲染。
+- 新图表优先复用 `charts.py` 的现有风格（`pyecharts` + 统一尺寸 + `opts` 配置）。
+- 若需复用作者维度统计，参考 `compute_author_stats()` 的字段：`is_active/phase/contribution_level/night_ratio`。

gitinsight_cli-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,70 @@
+name: Auto Release Wheel
+
+on:
+  push:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-release:
+    name: Build and Release Wheel
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Generate Version Number
+        id: version
+        run: |
+          # Use current timestamp as version: YYYY.MM.DD.HHMMSS
+          # Using UTC time to avoid timezone confusion and ensure monotonicity
+          VERSION_NUM=$(date -u +'%Y.%m.%d.%H%M%S')
+          echo "VERSION_NUM=$VERSION_NUM" >> $GITHUB_ENV
+          echo "Generated version: $VERSION_NUM"
+
+      - name: Update pyproject.toml version
+        run: |
+          # Simple sed replacement for the version field
+          # Matches 'version = "..."'
+          sed -i "s/version = \".*\"/version = \"${{ env.VERSION_NUM }}\"/" pyproject.toml
+          echo "Updated pyproject.toml version:"
+          grep "version =" pyproject.toml
+
+      - name: Build Wheel
+        run: |
+          uv build
+          
+          # Verify the output
+          echo "Build artifacts:"
+          ls -l dist/
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: "v${{ env.VERSION_NUM }}"
+          name: "Release v${{ env.VERSION_NUM }}"
+          files: dist/*.whl
+          make_latest: true
+          body: |
+            Auto-generated release from GitHub Actions.
+            Version: ${{ env.VERSION_NUM }}
+            Build Time: $(date)
+            
+            ## Platform Support
+            This release contains a **Pure Python Wheel** (`*-py3-none-any.whl`).
+            It is compatible with:
+            - ✅ **Windows (x64/ARM64)**
+            - ✅ **Linux (x64/ARM64)**
+            - ✅ **macOS (x64/ARM64)**
+            
+            Requires Python 3.12+.

gitinsight_cli-0.1.0/.gitignore

@@ -0,0 +1,222 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+.cache/
+
+*.html
+
+.DS_Store

gitinsight_cli-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

gitinsight_cli-0.1.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: gitinsight-cli
+Version: 0.1.0
+Summary: A powerful collection of Git repository analysis tools and visualizations.
+Project-URL: Homepage, https://github.com/Rain-kl/GitInsight
+Project-URL: Bug Tracker, https://github.com/Rain-kl/GitInsight/issues
+Author-email: Ryan <ryan@arctel.net>
+License-Expression: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: pandas>=3.0.0
+Requires-Dist: pyecharts>=2.0.0
+Requires-Dist: tqdm>=4.67.3
+Description-Content-Type: text/markdown
+
+# GitInsight
+
+GitRepository Analysis and Visualization Tool / Git 仓库分析与可视化工具
+
+<!-- PROJECT SHIELDS -->
+
+[![MIT License][license-shield]][license-url]
+
+[![Python Version][python-version]][python-version]
+
+---
+
+## 目录
+
+- [GitInsight](#gitinsight)
+  - [目录](#目录)
+    - [上手指南](#上手指南)
+          - [开发前的配置要求](#开发前的配置要求)
+          - [**安装步骤**](#安装步骤)
+    - [文件目录说明](#文件目录说明)
+    - [开发的架构](#开发的架构)
+    - [部署](#部署)
+    - [使用到的框架](#使用到的框架)
+    - [贡献者](#贡献者)
+      - [如何参与开源项目](#如何参与开源项目)
+
+### 上手指南
+
+###### 开发前的配置要求
+
+1. Python >= 3.12
+2. uv (推荐使用 uv 进行包管理) 或 pip
+
+###### **安装步骤**
+
+1. Clone the repo
+
+```sh
+git clone https://github.com/Rain-kl/GitInsight.git
+cd GitInsight
+```
+
+2. Install as a command-line tool
+
+```sh
+# Install from PyPI
+uv tool install gitinsight-cli
+
+# Install from the current checkout
+uv tool install .
+
+# Or install directly from GitHub
+uv tool install git+https://github.com/Rain-kl/GitInsight.git
+```
+
+3. Run the tool
+
+```sh
+gitinsight /path/to/git/repository
+```
+
+Upgrade or uninstall the tool:
+
+```sh
+uv tool upgrade gitinsight-cli
+uv tool uninstall gitinsight-cli
+```
+
+For local development:
+
+```sh
+uv sync
+uv run gitinsight /path/to/git/repository
+```
+
+### 文件目录说明
+
+```
+GitInsight
+├── .github/             # GitHub 配置
+├── gitinsight/          # 源代码目录
+│   ├── __init__.py
+│   ├── __main__.py      # 程序入口
+│   ├── analysis.py      # 分析逻辑 (Pandas)
+│   ├── charts.py        # 图表绘制 (Pyecharts)
+│   ├── dashboard.py     # 仪表盘展示
+│   ├── git_reader.py    # Git日志读取
+│   └── report.py        # 报告生成
+├── .gitignore
+├── pyproject.toml       # 项目配置与依赖
+├── uv.lock              # 依赖锁定文件
+└── README.md            # 项目说明
+```
+
+### 开发的架构
+
+本项目主要由数据读取、数据分析、图表生成和仪表盘展示四个部分组成。
+- `git_reader.py`: 负责读取 Git 仓库的提交日志。
+- `analysis.py`: 使用 Pandas 对日志数据进行清洗和统计分析。
+- `charts.py`: 使用 Pyecharts 生成各类可视化图表。
+- `dashboard.py`: 整合图表生成 HTML 仪表盘。
+
+请阅读架构文档(如有)查阅为该项目的架构。
+
+### 部署
+
+本项目为 Python 命令行工具，可直接本地运行或打包发布到 PyPI。
+暂无特殊部署部署。
+
+### 使用到的框架
+
+- [Pandas](https://pandas.pydata.org/) - Data structures and analysis tools
+- [Pyecharts](https://github.com/pyecharts/pyecharts) - Python Echarts Plotting Library
+- [Loguru](https://github.com/Delgan/loguru) - Python logging made (stupidly) simple
+- [Hatchling](https://hatch.pypa.io/latest/) - Modern, extensible Python build backend
+
+### 贡献者
+
+请阅读**CONTRIBUTING.md** 查阅为该项目做出贡献的开发者。
+
+#### 如何参与开源项目
+
+贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是**非常感谢**的。
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<!-- links -->
+[license-shield]: https://img.shields.io/github/license/shaojintian/Best_README_template.svg?style=flat-square
+[license-url]: https://github.com/Rain-kl/GitInsight/blob/main/LICENSE
+[python-version]:https://img.shields.io/pypi/pyversions/pandas

gitinsight_cli-0.1.0/README.md

@@ -0,0 +1,134 @@
+# GitInsight
+
+GitRepository Analysis and Visualization Tool / Git 仓库分析与可视化工具
+
+<!-- PROJECT SHIELDS -->
+
+[![MIT License][license-shield]][license-url]
+
+[![Python Version][python-version]][python-version]
+
+---
+
+## 目录
+
+- [GitInsight](#gitinsight)
+  - [目录](#目录)
+    - [上手指南](#上手指南)
+          - [开发前的配置要求](#开发前的配置要求)
+          - [**安装步骤**](#安装步骤)
+    - [文件目录说明](#文件目录说明)
+    - [开发的架构](#开发的架构)
+    - [部署](#部署)
+    - [使用到的框架](#使用到的框架)
+    - [贡献者](#贡献者)
+      - [如何参与开源项目](#如何参与开源项目)
+
+### 上手指南
+
+###### 开发前的配置要求
+
+1. Python >= 3.12
+2. uv (推荐使用 uv 进行包管理) 或 pip
+
+###### **安装步骤**
+
+1. Clone the repo
+
+```sh
+git clone https://github.com/Rain-kl/GitInsight.git
+cd GitInsight
+```
+
+2. Install as a command-line tool
+
+```sh
+# Install from PyPI
+uv tool install gitinsight-cli
+
+# Install from the current checkout
+uv tool install .
+
+# Or install directly from GitHub
+uv tool install git+https://github.com/Rain-kl/GitInsight.git
+```
+
+3. Run the tool
+
+```sh
+gitinsight /path/to/git/repository
+```
+
+Upgrade or uninstall the tool:
+
+```sh
+uv tool upgrade gitinsight-cli
+uv tool uninstall gitinsight-cli
+```
+
+For local development:
+
+```sh
+uv sync
+uv run gitinsight /path/to/git/repository
+```
+
+### 文件目录说明
+
+```
+GitInsight
+├── .github/             # GitHub 配置
+├── gitinsight/          # 源代码目录
+│   ├── __init__.py
+│   ├── __main__.py      # 程序入口
+│   ├── analysis.py      # 分析逻辑 (Pandas)
+│   ├── charts.py        # 图表绘制 (Pyecharts)
+│   ├── dashboard.py     # 仪表盘展示
+│   ├── git_reader.py    # Git日志读取
+│   └── report.py        # 报告生成
+├── .gitignore
+├── pyproject.toml       # 项目配置与依赖
+├── uv.lock              # 依赖锁定文件
+└── README.md            # 项目说明
+```
+
+### 开发的架构
+
+本项目主要由数据读取、数据分析、图表生成和仪表盘展示四个部分组成。
+- `git_reader.py`: 负责读取 Git 仓库的提交日志。
+- `analysis.py`: 使用 Pandas 对日志数据进行清洗和统计分析。
+- `charts.py`: 使用 Pyecharts 生成各类可视化图表。
+- `dashboard.py`: 整合图表生成 HTML 仪表盘。
+
+请阅读架构文档(如有)查阅为该项目的架构。
+
+### 部署
+
+本项目为 Python 命令行工具，可直接本地运行或打包发布到 PyPI。
+暂无特殊部署部署。
+
+### 使用到的框架
+
+- [Pandas](https://pandas.pydata.org/) - Data structures and analysis tools
+- [Pyecharts](https://github.com/pyecharts/pyecharts) - Python Echarts Plotting Library
+- [Loguru](https://github.com/Delgan/loguru) - Python logging made (stupidly) simple
+- [Hatchling](https://hatch.pypa.io/latest/) - Modern, extensible Python build backend
+
+### 贡献者
+
+请阅读**CONTRIBUTING.md** 查阅为该项目做出贡献的开发者。
+
+#### 如何参与开源项目
+
+贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是**非常感谢**的。
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<!-- links -->
+[license-shield]: https://img.shields.io/github/license/shaojintian/Best_README_template.svg?style=flat-square
+[license-url]: https://github.com/Rain-kl/GitInsight/blob/main/LICENSE
+[python-version]:https://img.shields.io/pypi/pyversions/pandas

gitinsight_cli-0.1.0/build_wheel.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+set -e
+
+# Get the directory of the script
+script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+cd "$script_dir"
+
+# Clean up previous build artifacts
+echo "Cleaning up previous builds..."
+rm -rf dist/
+rm -rf build/
+rm -rf *.egg-info
+
+# Build the package using uv
+if command -v uv &> /dev/null; then
+    echo "Building with uv..."
+    uv build
+else
+    echo "uv not found, falling back to python build module..."
+    # Ensure build module is installed
+    python3 -m pip install --upgrade build
+    python3 -m build
+fi
+
+echo "------------------------------------------------"
+echo "Build complete! Wheel file can be found in dist/"
+ls -lh dist/*.whl