<commit_before>=====
cstat
=====

*A visual stat tool for Crate clusters*

... formerly known as ``ctop``.

``cstat`` is ispired by the awesome interactive process monitoring tool `htop`_.
``cstat`` should be a similar tool to `iostat`_, but for monitoring `Crate`_
clusters.

.. image:: screenshot.png
   :scale: 100%
   :alt: Screenshot of cstat in action

Installation
=============

Right now, ``stat`` is only available from `Github`_. Therefore you need to
checkout the repository and run ``pip install`` on the local directory.
A first version should be available from PyPi_ in summer 2016.

::

    git clone https://github.com/chaudum/crate-top.git cstat
    cd cstat
    python3.4 -m env
    source ./env/bin/activate
    pip install -e .

Usage
=====

After installation the program can be invoked by the following command::

    >>> cstat --help
    usage: cstat [-h] [--hosts HOST [HOST ...]] [--interval INTERVAL] [--version]

    A visual stat tool for Crate clusters

    optional arguments:
      -h, --help            show this help message and exit
      --hosts HOST [HOST ...], --crate-hosts HOST [HOST ...]
                            one or more Crate hosts to connect to
      --interval INTERVAL, --refresh-interval INTERVAL
                            amount of time in seconds between each update<commit_msg>updated installation instructions in readme<commit_after>=====
cstat
=====

*A visual stat tool for Crate clusters*

... formerly known as ``ctop``.

``cstat`` is ispired by the awesome interactive process monitoring tool `htop`_.
``cstat`` should be a similar tool to `iostat`_, but for monitoring `Crate`_
clusters.

.. image:: screenshot.png
   :scale: 100%
   :alt: Screenshot of cstat in action

Installation
=============

Right now, ``stat`` is only available from `Github`_. Therefore you need to
checkout the repository and run ``pip install`` on the local directory.
A first version should be available from PyPi_ in summer 2016.

::

    git clone https://github.com/chaudum/crate-top.git cstat
    cd cstat
    python3.4 -m venv env
    source ./env/bin/activate
    pip install -e .

Usage
=====

After installation the program can be invoked by the following command::

    >>> cstat --help
    usage: cstat [-h] [--hosts HOST [HOST ...]] [--interval INTERVAL] [--version]

    A visual stat tool for Crate clusters

    optional arguments:
      -h, --help            show this help message and exit
      --hosts HOST [HOST ...], --crate-hosts HOST [HOST ...]
                            one or more Crate hosts to connect to
      --interval INTERVAL, --refresh-interval INTERVAL
                            amount of time in seconds between each update
{'fraction_non_alphanumeric': 0.11460258780036968, 'fraction_numerical': 0.006654343807763401, 'mean_word_length': 2.6273458445040214, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, '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': '1391764', 'n_tokens_mistral': 788, 'n_tokens_neox': 741, 'n_words': 328}