<commit_before>============
Installation
============

Operating System Requirements
-----------------------------

This tool is best run on a Linux distribution, it may work on Mac, but has not
been tested as yet.

The main OS package requirements are listed below

Fedora / Centos
---------------

Rats::

    sudo dnf install rats

VirtualEnv::

    sudo dnf install python-virtualenv

Python Pip::<commit_msg>Updating docs for Docker instructions<commit_after>============
Installation
============

Operating System Requirements
-----------------------------

This tool is best run on a Linux distribution, it may work on Mac, but has not
been tested as yet. The recommended way is using docker, as that way it will
not interfere with your local systems package installations.

The main OS package requirements are listed below

Docker
------

Get the latest Dockerfile::

    https://raw.githubusercontent.com/lukehinds/anteater/master/docker/Dockerfile

Build the Image:

    docker build -t anteater .

Note: `.` denotes the current working directory, so run this from whereever you
downloaded the Dockerfile.

Run an instance:

    docker run -t -i anteater /bin/bash

To retrieve the html reports, use docker cp::

    docker cp <containerId>:/file/path/reports /host/path/reports

Fedora / Centos
---------------

Rats::

    sudo dnf install rats

VirtualEnv::

    sudo dnf install python-virtualenv

Python Pip::
{'fraction_non_alphanumeric': 0.14726507713884993, 'fraction_numerical': 0.0, 'mean_word_length': 2.9419889502762433, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, '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': '4187616', 'n_tokens_mistral': 404, 'n_tokens_neox': 367, 'n_words': 167}