<commit_before># Midwife
[![Build Status](https://travis-ci.org/rlyon/midwife.png?branch=master)](https://travis-ci.org/rlyon/midwife)
[![Coverage Status](https://coveralls.io/repos/rlyon/midwife/badge.png)](https://coveralls.io/r/rlyon/midwife)

TODO: Write a gem description

## Installation

Add this line to your application's Gemfile:

    gem 'midwife'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install midwife

## Usage

TODO: Write usage instructions here

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

### Seting up for the kickstart validation tests

To run the kickstart validation tests on your local system, you
will need an install of python.  I'm using 2.7, I don't know if
it makes a difference.  On Mac use homebrew or macports to avoid
using the system python which is bound to be really, really old.
On Linux you can use your favorite package manager.

    $ brew install python
    $ pip install virtualenv

Once python has been installed, run

    $ rake validator:setup

This will create the directories that you need, set up a virtual
environment and get everything ready for the integration tests.
<commit_msg>starting on docs<commit_after># Midwife
[![Build Status](https://travis-ci.org/rlyon/midwife.png?branch=master)](https://travis-ci.org/rlyon/midwife)
[![Coverage Status](https://coveralls.io/repos/rlyon/midwife/badge.png)](https://coveralls.io/r/rlyon/midwife)

Midwife is a kickstart generation tool and server for CentOS and Redhat systems.  
It aims to fill the gap in the deployment of bare metal systems that current tools
provide.

## Installation

Installation using rubygems:

    $ gem install midwife

Install the latest version from the github:

    $ git clone https://github.com/rlyon/midwife.git

## Usage

#### TODO: Write usage instructions here

## Contributing

### Grab the source and make a branch

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

### Seting up for the kickstart validation tests

To run the kickstart validation tests on your local system, you
will need an install of python.  I'm using 2.7, I don't know if
it makes a difference.  On Mac use homebrew or macports to avoid
using the system python which is bound to be really, really old.
On Linux you can use your favorite package manager.

    $ brew install python
    $ pip install virtualenv

Once python has been installed, run

    $ rake validator:setup

This will create the directories that you need, set up a virtual
environment and get everything ready for the integration tests.

### Run the tests to see if it breaks

    $ rake test
{'fraction_non_alphanumeric': 0.08333333333333333, 'fraction_numerical': 0.004723346828609987, 'mean_word_length': 3.9581939799331103, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 9, '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': '3328313', 'n_tokens_mistral': 901, 'n_tokens_neox': 847, 'n_words': 389}