<commit_before>#GitMap 
##Description
GitMap creates a map of a git repository, showing all the commits of each branch. 
The map will be saved in a plain text file with the name of (TBD). 
Currently, the script will only work if every branch is derived from the same head branch.    
The map will show the author, date, and message of each commit. 
The information of each commit is contained within a box. 
Currently, the box will look like 
```
.______________________   
|......................|
|Author: Name of Author|		
|Date: Date of commit..|    		
|Commit Message........|		
|______________________|   
```
The commits at the top of the file refer to the most recent commits. 
The box points upward to show the next/more recent commit. 
An arrow pointing to the side from the commit message means the branch has ended.
The long list of periods is to format the box correctly. 
An example would be
```
.______________________________   
|..............................|
|Author: <NAME>........|		
|Date: Wed Jun 10 14:29:09 2015|   
|Most recent commit............| -----> (master)	
|______________________________|

^    
|    
.______________________________   
|..............................|
|Author: <NAME>........|		
|Date: Wed Jun 10 14:20:28 2015|   
|Less recent commit............|    
|______________________________|
```
The program's run time will depend upon the amount of branches and commits that your git repository contains, as the greater the
number of commits and branches there are, the longer it will take for the program to finish executing.
For a place of comparison, a git repository with only the `master` branch, and 100 commits, will take about 40 seconds to run.
The resulting file will be stored in the directory that was passed into the command.


##Warning
Before running this program on a git repository, commit all changes to the repository. 
All uncommited changes will be reverted to the last commit.

##Downloading and Running
To download, run the command:    
```
$ git clone https://github.com/ykamo001/GitMap  
$ . PathToGitMap/src/GitMap.sh PathToYourGitRepo 
```
If no PathToYourGitRepo is passed in such as
```
$ . PathToGitMap/GitMap.sh
```
The script will run on the current directory.

#Error Messages
* If PathToYourGitRepo is not passed in when running the script,   
`Path was not specified. Script will execute in current directory` 
* If `PathToGitMap/GitMap.sh PathToYourGitRepo` is passed in, 
the screen will output 
`bash: PathToGitMap/GitMap.sh: /bin/bash: bad interpreter: Not a directory`
* When run on a directory that is not a git repository, 
the screen will output 
```
fatal: Not a git repository (or any parent up to mount point /homeDirectory)    
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).   
wc: ./RandomTempFileName/master: No such file or directory    
bash: [: 0: unary operator expected
bash: ./RandomTempFileName/master: Nosuch file or directory
```<commit_msg>added src/ to every PathToGitMap<commit_after>#GitMap 
##Description
GitMap creates a map of a git repository, showing all the commits of each branch. 
The map will be saved in a plain text file with the name of (TBD). 
Currently, the script will only work if every branch is derived from the same head branch.    
The map will show the author, date, and message of each commit. 
The information of each commit is contained within a box. 
Currently, the box will look like 
```
.______________________   
|......................|
|Author: Name of Author|		
|Date: Date of commit..|    		
|Commit Message........|		
|______________________|   
```
The commits at the top of the file refer to the most recent commits. 
The box points upward to show the next/more recent commit. 
An arrow pointing to the side from the commit message means the branch has ended.
The long list of periods is to format the box correctly. 
An example would be
```
.______________________________   
|..............................|
|Author: <NAME>........|		
|Date: Wed Jun 10 14:29:09 2015|   
|Most recent commit............| -----> (master)	
|______________________________|

^    
|    
.______________________________   
|..............................|
|Author: <NAME>........|		
|Date: Wed Jun 10 14:20:28 2015|   
|Less recent commit............|    
|______________________________|
```
The program's run time will depend upon the amount of branches and commits that your git repository contains, as the greater the
number of commits and branches there are, the longer it will take for the program to finish executing.
For a place of comparison, a git repository with only the `master` branch, and 100 commits, will take about 40 seconds to run.
The resulting file will be stored in the directory that was passed into the command.


##Warning
Before running this program on a git repository, commit all changes to the repository. 
All uncommited changes will be reverted to the last commit.

##Downloading and Running
To download, run the command:    
```
$ git clone https://github.com/ykamo001/GitMap  
$ . PathToGitMap/src/GitMap.sh PathToYourGitRepo 
```
If no PathToYourGitRepo is passed in such as
```
$ . PathToGitMap/src/GitMap.sh
```
The script will run on the current directory.

#Error Messages
* If PathToYourGitRepo is not passed in when running the script,   
`Path was not specified. Script will execute in current directory` 
* If `PathToGitMap/src/GitMap.sh PathToYourGitRepo` is passed in, 
the screen will output 
`bash: PathToGitMap/src/GitMap.sh: /bin/bash: bad interpreter: Not a directory`
* When run on a directory that is not a git repository, 
the screen will output 
```
fatal: Not a git repository (or any parent up to mount point /homeDirectory)    
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).   
wc: ./RandomTempFileName/master: No such file or directory    
bash: [: 0: unary operator expected
bash: ./RandomTempFileName/master: Nosuch file or directory
```
{'fraction_non_alphanumeric': 0.10904833584211407, 'fraction_numerical': 0.011038635223281485, 'mean_word_length': 3.2928930366116296, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 9, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '33601', 'n_tokens_mistral': 1694, 'n_tokens_neox': 1534, 'n_words': 782}