<commit_before>===============================
Cosmos: a CLI gate to the stars
===============================

This script allows you to create, list, see the details of Cosmos clusters.

Install Cosmos CLI from sources
===============================

The target directory will be determined by your Python installation. Usually,
it will bundle an egg into the 'site-packages' directory, and a script to the
same directory where the 'python' executable is found.  You must have `python`
and `setuptools` installed in your system.

Install using::

    $ python setup.py install

If you would like to uninstall later, use::

    $ python setup.py install --record installs.txt
    $ cat installs.txt | xargs rm -rf

Install Cosmos CLI EGG
======================

To generate a redistributable archive by means of `setuptools`::

    $ python setup.py bdist_egg

This will create a file named `dist/cosmos-<cosmos version>-<python version>.egg`
tha can be downloaded and installed on any system with `python` and
`setuptools` as follows::

    $ easy_install cosmos-<version>.egg

Or directly from the network::

    $ easy_install http://location/path/cosmos-<version>.egg

Configure Cosmos
================

By default, your cosmos is supposed to be at http://localhost:9000/cosmos but
you can create a custom config file by::

    $ cosmos configure

Let the universe spin
=====================

- Create a cluster::

   $ cosmos create --name <name> --size <size>

- List clusters::

   $ cosmos list

- See cluster details::

   $ cosmos show <cluster id>
<commit_msg>[cosmos-cli] Update README.rst about buildout use<commit_after>===============================
Cosmos: a CLI gate to the stars
===============================

This script allows you to create, list, see the details of Cosmos clusters.

Install Cosmos CLI from sources
===============================

The target directory will be determined by your Python installation. Usually,
it will bundle an egg into the 'site-packages' directory, and a script to the
same directory where the 'python' executable is found.  You must have `python`
and `setuptools` installed in your system.

Install using `buildout`::

    $ python ./bootstrap.py
    $ bin/bootstrap
    $ sudo bin/buildout setup . install

If you would like to uninstall later, use::

    $ sudo bin/buildout setup . install --record installs.txt
    $ cat installs.txt | xargs rm -rf

Install Cosmos CLI EGG
======================

To generate a redistributable archive by means of `setuptools`::

    $ bin/buildout setup . bdist_egg

This will create a file named `dist/cosmos-<cosmos version>-<python version>.egg`
tha can be downloaded and installed on any system with `python` and
`setuptools` as follows::

    $ easy_install cosmos-<version>.egg

Or directly from the network::

    $ easy_install http://location/path/cosmos-<version>.egg

Configure Cosmos
================

By default, your cosmos is supposed to be at http://localhost:9000/cosmos but
you can create a custom config file by::

    $ cosmos configure

Let the universe spin
=====================

- Create a cluster::

   $ cosmos create --name <name> --size <size>

- List clusters::

   $ cosmos list

- See cluster details::

   $ cosmos show <cluster id>

{'fraction_non_alphanumeric': 0.16319657072872015, 'fraction_numerical': 0.002449479485609308, 'mean_word_length': 4.088785046728972, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 17, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '75692', 'n_tokens_mistral': 920, 'n_tokens_neox': 857, 'n_words': 387}