<commit_before>CAS Reader
==========

The python repository reader.

##Running
In a terminal, type `python readRepo.py "path/to/repo"` to parse the commits and store them in a database
<commit_msg>Updated readme to include installation steps.<commit_after>CAS Reader
==========

A git repository commit parser that inserts  each commit into a  PostgreSQL table.

##Installation
Clone this repository in to an empty directory 

###Dependencies
* Python  >= 3.3
* Pip for Python Version > 3.3
* Git > 1.7

###Pip Packages
Install the following packages by doing `pip install `  and then the package name

* SQL Alchemy (sqlalchemy)
* Py-PostgreSQL (py-postgresql)


##Quick Start
In a terminal, type `python readRepo.py "path/to/repo"` to parse the commits and store them in a database.

{'fraction_non_alphanumeric': 0.09936305732484077, 'fraction_numerical': 0.007643312101910828, 'mean_word_length': 4.496503496503497, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 6, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3559936', 'n_tokens_mistral': 239, 'n_tokens_neox': 223, 'n_words': 102}