Metadata-Version: 2.1
Name: heatwave
Version: 1.0
Summary: A way of visualizing a heat map of a git repo
Home-page: https://github.com/james-stoup/heatwave
Author: James Stoup
Author-email: jrstoup@gmail.com
License: GNU General Public License v3.0
Description: # heatwave
        
        A tool for displaying a visual representation of your git history. 
        
        Heatwave generates a heat map of your git commits, similar to how GitHub's heat map looks. View all commits or a single user's commits for the past year or previous years.
        
        
        ## Installation
        
        Clone this repo and then install all neede requirements use pip like so:
        
        ```pip install -r requirements.txt'```
        
          
        ## Usage
        
        ### View All Committers
        View repo stats for all committers:
        
        ```
        $ ./heatwave.py /path/to/my/repo -a
        ```
        
        ![All Commits](https://github.com/james-stoup/heatwave/blob/master/resources/all-users-1-year.png)
        
        
        ### View All Committers For Several Years
        View 3 years worth of commits:
        
        ```
        $ ./heatwave.py /path/to/my/repo -a -y 3
        ```
        
        ![3 Years of Committs](https://github.com/james-stoup/heatwave/blob/master/resources/all-users-3-years.png)
        
        
        ### View A Specific Committer
        View stats on a particular committer:
        
        ```
        $ ./heatwave.py 'James Stoup' /path/to/my/repo
        ```
        
        ![One User](https://github.com/james-stoup/heatwave/blob/master/resources/one-user.png)
        
        
        ### View Number of Commits
        View number of commits a user made, instead of color:
        
        ```
        $ ./heatwave.py --status-type number 'James Stoup' /path/to/my/repo
        ```
        
        ![One User By Numbers](https://github.com/james-stoup/heatwave/blob/master/resources/one-user-numbers.png)
        
        
        ### Other Options
        List everyone who committed to this repo:
        
        ```
        $ ./heatwave.py /path/to/my/repo -l
        ```
        
        
        View detailed stats on a particular committer:
        
        ```
        $ ./heatwave.py -v 'James Stoup' /path/to/my/repo
        ```
        
        
        View detailed stats on everyone going back 10 years
        
        ```
        $ ./heatwave.py /path/to/my/repo -v -a -y 10
        ```
        
        
Keywords: git visualize heatmap
Platform: UNKNOWN
Description-Content-Type: text/markdown
