<commit_before># Clouseau

[![Build Status](https://travis-ci.org/cfpb/clouseau.svg)](https://travis-ci.org/cfpb/clouseau)


## What is Clouseau?

Clouseau is a silly git repo inspector. 

Clouseau is a P.I. for your PII. It searches git commits -- source code and commit messages -- for undesirable text patterns, such as passwords, ssh keys and personal identifiable information. You can create other patterns to search for profanity or search for other information with a regular expression specified on the command line. 

See the **Get Involved** section at the end of this readme to see the current status of this project and contribute.

## Dependencies

 - git
 - Python 2.7
 
See the [requirements.txt](requirements.txt) file for additional dependencies to be installed in the quick setup.


## Quick setup

1. Clone this repository somewhere you can execute Python code.

1. From the cloned Clouseau project root, set up a virtualenv:
   ```sh
   virtualenv --no-site-packages --distribute venv    # creates the virtualenv named "venv"
   source venv/bin/activate                           # activates (places you in) the virtualenv
   ```

1. Install the requirements:
   ```sh
   pip install -r requirements.txt
   ```

4. Tell Python to also look in this directory for libraries.
   ```sh
   export PYTHONPATH=$PYTHONPATH:.<commit_msg>Adding links to Dependencies<commit_after># Clouseau

[![Build Status](https://travis-ci.org/cfpb/clouseau.svg)](https://travis-ci.org/cfpb/clouseau)


## What is Clouseau?

Clouseau is a silly git repo inspector. 

Clouseau is a P.I. for your PII. It searches git commits -- source code and commit messages -- for undesirable text patterns, such as passwords, ssh keys and personal identifiable information. You can search for profanity or other information with a new pattern file or a regular expression specified on the command line. 

See the **Get Involved** section at the end of this readme to see the current status of this project and contribute.

## Dependencies
 - Unix-based OS, such as Mac or Linux (Windows support is unclear at this time.) 
 - [git](http://git-scm.com/)
 - [Python 2.7](https://www.python.org/download/releases/2.7/)
 
See the [requirements.txt](requirements.txt) file for additional dependencies to be installed in the quick setup.


## Quick setup

1. Clone this repository somewhere you can execute Python code.

1. From the cloned Clouseau project root, set up a virtualenv:
   ```sh
   virtualenv --no-site-packages --distribute venv    # creates the virtualenv named "venv"
   source venv/bin/activate                           # activates (places you in) the virtualenv
   ```

1. Install the requirements:
   ```sh
   pip install -r requirements.txt
   ```

4. Tell Python to also look in this directory for libraries.
   ```sh
   export PYTHONPATH=$PYTHONPATH:.
{'fraction_non_alphanumeric': 0.08488249736934408, 'fraction_numerical': 0.004910557699052964, 'mean_word_length': 3.45625, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 5, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6730781', 'n_tokens_mistral': 832, 'n_tokens_neox': 779, 'n_words': 353}