https://github.com/juanjfarina/git-stats-report
Git Stats Report tool for obtaining the different authors and contributions for a given project in certain timelapse.
https://github.com/juanjfarina/git-stats-report
2024 analysis cicd cli git product-idea released report statistics tool
Last synced: 2 months ago
JSON representation
Git Stats Report tool for obtaining the different authors and contributions for a given project in certain timelapse.
- Host: GitHub
- URL: https://github.com/juanjfarina/git-stats-report
- Owner: JuanJFarina
- License: mit
- Created: 2024-03-17T01:43:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T15:03:58.000Z (about 2 years ago)
- Last Synced: 2026-01-02T16:28:06.578Z (6 months ago)
- Topics: 2024, analysis, cicd, cli, git, product-idea, released, report, statistics, tool
- Language: Python
- Homepage: https://pypi.org/project/git-stats-report/
- Size: 81.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# git-stats-report
| PyPI | [](https://pypistats.org/packages/git-stats-report) [](https://pypi.org/project/git-stats-report/) 
  |
|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Quality | [](https://coveralls.io/github/JuanJFarina/git-stats-report) [](https://codeclimate.com/github/JuanJFarina/git-stats-report) [](https://codeclimate.com/github/JuanJFarina/git-stats-report)
 [](https://github.com/JuanJFarina/git-stats-report/blob/master/.github/dependabot.yml) |
| Format |  
   |
| Legal | [](https://app.fossa.com/projects/git%2Bgithub.com%2FJuanJFarina%2Fgit-stats-report) [](./LICENSE)  |
🔍 Git Stats Reports 🔍
## Usage
Use the --help flag for detailed options:
```shell
git-stats-report --help
```
git-stats-report can be used in different ways, the most straightforward one is:
```shell
git-stats-report -s "4"
```
This will return statistics for each contributor since four days ago. The -s flag accepts
any number greater than 0
Other use of git-stats-report is with the -st flag, which allows to change the default
behaviour, SINCE_DAYS, to FROM_LATEST_TAG:
```shell
git-stats-report -st "FROM_LATEST_TAG"
```
This will return statistics for each contributor since the last generated tag. Using the
-st flag, the -s flag is not needed.
A last option is the -r flag, which will return the raw string with linebreaks:
```shell
git-stats-report -r -s "4"
```
The output will be more suitable in some cases, like in CI/CD pipelines if you want to
store the report in a variable and print it somewhere else.
## Installation
### With Pipx
Recommended instalation for CICD is through `pipx` with a pinned version:
```shell
pip install pipx==1.2.0
pipx run git-stats-report==0.3.2
```
That command will create a virtual environment just for git-stats-report and return the
report.
### With pip
Instalation can be done with pip as usual:
```shell
pip install git-stats-report
```
Pipenv and poetry equivalents can be used as well.
## F.A.Q.
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2FJuanJFarina%2Fgit-stats-report)