# gitstats

**Repository Path**: ccwq/gitstats

## Basic Information

- **Project Name**: gitstats
- **Description**: 在windows上使用gitstats进行项目统计
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 1
- **Created**: 2023-03-01
- **Last Updated**: 2024-04-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目作用

在windows上使用gitstats进行项目统计

# GitStats介绍

GitStats是一个生成Git代码库统计信息的工具，它使用Python编写，可以生成有关Git代码库的各种统计数据和报告。GitStats可以在命令行中使用，也可以将其作为Web界面运行。

GitStats可以生成以下各种统计数据：

- 代码提交数量和贡献者信息
- 代码提交者的活跃程度和变化趋势
- 代码库的分支、标签和提交历史
- 代码库的代码行数、文件数量、文件类型分布和代码行数变化趋势
- 代码库的代码质量指标，如圈复杂度、代码行数和测试覆盖率

GitStats还提供了以下几种输出格式：

- HTML格式报告
- 文本格式报告
- JSON格式报告

要使用GitStats，您需要在计算机上安装Python，并将其添加到PATH环境变量中。您还需要安装GitStats软件包，并使用Git命令行工具克隆您要分析的Git代码库。一旦完成这些步骤，您可以在命令行中输入以下命令来生成GitStats报告：

# gitstats存在问题

GitStats 在windows上使用会劝退不少初次使用者,所以该项目简化了配置流程,并且提供了一键启动脚本

# 基本环境要求

- <b style="color:red">请确保安装python3.x</b> 建议版本pyton3.9.1(已验证)
- 确保git已安装

# 使用方式

- clone或者download zip本项目到本地解压
- ~~在项目的根目录空白处单击右建,在菜单种执行"Git Bash Here"~~
- 执行下列命令之一 <b style=color:red>注意路径格式</b>
  - ```./start.bat e:\\path\\to\\targe-projectr```
    
     结果输出到项目根目录下的report目录
  - ```./start.bat e:/path/to/targe-projectr```

    同上
  - ```./start.bat e:/path/to/targe-projectr e:/path/to/report-output```

    结果输出到指定目录
  
---

# 参考资料:

感谢以下开源项目和文章的作者

-   gitstats官网: <https://github.com/hoxu/gitstats>
-   gitstats 在 windows 下使用异常，‘wc‘ 不是内部或外部命令，也不是可运行的程序<https://www.cnblogs.com/jicheng999/p/16156213.html>
-   Git项目代码统计-Python3版gitstats  
    <https://www.cnblogs.com/superhin/p/11701110.html>