<commit_before>=================
InfraRed CLI tool
=================

Reduce users' dependency on external CLI tools (Ansible and others).

Setup
=====

.. note:: On Fedora 23 `BZ#1103566 <https://bugzilla.redhat.com/show_bug.cgi?id=1103566>`_
 calls for::

  $ dnf install redhat-rpm-config

Use pip to install from source::

  $ pip install <path_to_infrared_dir>

So, After cloning repo from GitHub::

 $ cd Infrared
 $ pip install .

.. note:: For development work it's better to install in editable mode::

  $ pip install -e .

Conf
====

.. note:: Assumes that ``infrared`` is installed, else follow Setup_.

``infrared`` will look for ``infrared.cfg`` in the following order:

#. In working directory: ``./infrared.cfg``
#. In user home directory: ``~/.infrared.cfg``
#. In system settings: ``/etc/infrared/infrared.cfg``

.. note:: To specify a different directory or different filename, override the
 lookup order with ``IR_CONFIG`` environment variable::

    $ IR_CONFIG=/my/config/file.ini infrared --help

Running InfraRed
================

.. note:: Assumes that ``infrared`` is installed, else follow Setup_.

You can get general usage information with the ``--help`` option::

  infrared --help

This displays options you can pass to ``infrared``.

Extra-Vars
----------
One can set/overwrite settings in the output file using the '-e/--extra-vars'
option. There are 2 ways of doing so:

1. specific settings: (``key=value`` form)
    ``--extra-vars provisioner.site.user=a_user``
2. path to a settings file: (starts with ``@``)
    ``--extra-vars @path/to/a/settings_file.yml``

The ``-e``/``--extra-vars`` can be used more than once.

Merging order
-------------
Except options based on the settings dir structure, ``infrared`` accepts input of
predefined settings files (with ``-n``/``--input``) and user defined specific options
(``-e``/``--extra-vars``).
The merging priority order listed below:

1. Input files
2. Settings dir based options
3. Extra Vars<commit_msg>Updates README according the new input short-hand<commit_after>=================
InfraRed CLI tool
=================

Reduce users' dependency on external CLI tools (Ansible and others).

Setup
=====

.. note:: On Fedora 23 `BZ#1103566 <https://bugzilla.redhat.com/show_bug.cgi?id=1103566>`_
 calls for::

  $ dnf install redhat-rpm-config

Use pip to install from source::

  $ pip install <path_to_infrared_dir>

So, After cloning repo from GitHub::

 $ cd Infrared
 $ pip install .

.. note:: For development work it's better to install in editable mode::

  $ pip install -e .

Conf
====

.. note:: Assumes that ``infrared`` is installed, else follow Setup_.

``infrared`` will look for ``infrared.cfg`` in the following order:

#. In working directory: ``./infrared.cfg``
#. In user home directory: ``~/.infrared.cfg``
#. In system settings: ``/etc/infrared/infrared.cfg``

.. note:: To specify a different directory or different filename, override the
 lookup order with ``IR_CONFIG`` environment variable::

    $ IR_CONFIG=/my/config/file.ini infrared --help

Running InfraRed
================

.. note:: Assumes that ``infrared`` is installed, else follow Setup_.

You can get general usage information with the ``--help`` option::

  infrared --help

This displays options you can pass to ``infrared``.

Extra-Vars
----------
One can set/overwrite settings in the output file using the '-e/--extra-vars'
option. There are 2 ways of doing so:

1. specific settings: (``key=value`` form)
    ``--extra-vars provisioner.site.user=a_user``
2. path to a settings file: (starts with ``@``)
    ``--extra-vars @path/to/a/settings_file.yml``

The ``-e``/``--extra-vars`` can be used more than once.

Merging order
-------------
Except options based on the settings dir structure, ``infrared`` accepts input of
predefined settings files (with ``-i``/``--input``) and user defined specific options
(``-e``/``--extra-vars``).
The merging priority order listed below:

1. Input files
2. Settings dir based options
3. Extra Vars
{'fraction_non_alphanumeric': 0.1661684105630294, 'fraction_numerical': 0.01096163428001993, 'mean_word_length': 3.8026315789473686, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 2, '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': '3331625', 'n_tokens_mistral': 1279, 'n_tokens_neox': 1156, 'n_words': 463}