<commit_before># openshift-compliance
OpenShift Compliance documentation

## ReStructuredText Primer

For help with ReStructuredText syntax, check out the [Quickstart Guide](http://docutils.sourceforge.net/docs/user/rst/quickstart.html).

This one is good too: [Sphinx reST Syntax](http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html).

## Getting started

To get started, install Sphinx and the RTD Python modules.

```
$ sudo pip install Sphinx
$ sudo pip install sphinx_rtd_theme
```

Once you have made changes to your docs, commit your changes. You can build
the docs to view locally.

```
$ git add -A
$ git commit -am 'my commit message'
$ make html
```

Sanity check the output for errors. The docs can be viewed in the ```_biuld/html``` directory.

## Read the Docs

For the time being, this project is being distributed via [Read the Docs](http://readthedocs.org)

The main page is at [http://openshift-compliance-guide.readthedocs.io](http://openshift-compliance-guide.readthedocs.io/en/latest/index.html).

<commit_msg>updated readme with instructions to parse the master spreadsheet<commit_after># openshift-compliance
OpenShift Compliance documentation

## ReStructuredText Primer

For help with ReStructuredText syntax, check out the [Quickstart Guide](http://docutils.sourceforge.net/docs/user/rst/quickstart.html).

This one is good too: [Sphinx reST Syntax](http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html).

## Getting started

To get started, install Sphinx and the RTD Python modules.

```
$ sudo pip install Sphinx
$ sudo pip install sphinx_rtd_theme
$ sudo pip install openpyxl
```

The master security control tracibility matrix (SCTM) is [master_sctm.xlsx]. It needs to be parsed by [master_sctm_parser.py], which generates [controls.rst] via the [security_control.j2] (Jinja2)[http://jinja.pocoo.org/docs/dev/] template.

Once you have made changes to your docs, commit your changes. You can build
the docs to view locally.

```
$ python master_sctm_parser.py master_sctm.xlsx
$ git add -A
$ git commit -am 'my commit message'
$ make html
```

Sanity check the output for errors. The docs can be viewed in the ```_biuld/html``` directory.

## Read the Docs

For the time being, this project is being distributed via [Read the Docs](http://readthedocs.org)

The main page is at [http://openshift-compliance-guide.readthedocs.io](http://openshift-compliance-guide.readthedocs.io/en/latest/index.html).


{'fraction_non_alphanumeric': 0.10240718074255406, 'fraction_numerical': 0.0008159934720522236, 'mean_word_length': 4.728971962616822, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, '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': '4564372', 'n_tokens_mistral': 828, 'n_tokens_neox': 760, 'n_words': 263}