An open API service indexing awesome lists of open source software.

https://github.com/orltom/git-history-tools

Command line tool to group commits by user
https://github.com/orltom/git-history-tools

git

Last synced: 5 months ago
JSON representation

Command line tool to group commits by user

Awesome Lists containing this project

README

          

# git-history-tools

![](https://github.com/orltom/git-history-tools/workflows/Python%20package/badge.svg)
[![MIT License](https://raw.githubusercontent.com/orltom/git-history-tools/master/.github/license.svg?sanitize=true)](https://github.com/orltom/git-history-tools/blob/master/LICENSE)

Command line tool to group commits by user for a specific time window.

## Installation
```
pip install git-history-tools
```

## Usage
To run the program requires python version 3.6 or higher and a few libraries must be installed (see requirements.txt).

```
>>./githistory --help
githistory

Description:
Group GIT commits by user and show changes in a compact mode

Usage:
githistory [-b ] [-i ] [-d ] [--since date] [--after date]

Options:
-h --help Show this screen.
-b --branch GIT branch name [default: master]
-i --issue Regex pattern which correspond the issue ID. [default: ""]
-d --deep change file deep [default: 1]
--since Start date: format (%Y-%m-%d %H:%M:%S). Default is today -1
--after End date: format (%Y-%m-%d %H:%M:%S). Default is today -2
GIT repository path.
```

## Docker
```
docker build . -t githistory
docer run --rm --volume "/my/repo:/tmp/repo" -it githistory --branch master --deep 3 /tmp/rep
```

## Disclaimer
This software is provided as source code under an MIT license (see LICENSE)