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

First install http://github.com/tendrl/bridge_common

At the command line::

    $ python setup.py install

Or, if you have virtualenvwrapper installed::

    $ mkvirtualenv node_agent
    $ pip install node_agent<commit_msg>align installation doc with other tendr projects<commit_after>============
Installation
============

Since there is no stable release yet, the only option is to install the project
from the source.

Development version from the source
-----------------------------------

First install http://github.com/tendrl/bridge_common from the source code::

    $ git clone https://github.com/Tendrl/bridge_common.git
    $ cd bridge_common
    $ mkvirtualenv node_agent
    $ pip install .

Then install node agent itself::

    $ git clone https://github.com/Tendrl/node_agent.git
    $ cd node_agent
    $ workon node_agent
    $ pip install .

Note that we use virtualenvwrapper_ here to activate ``node_agent`` `python
virtual enviroment`_. This way, we install *node agent* into the same virtual
enviroment which we have created during installation of *bridge common*.

.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
.. _`python virtual enviroment`: https://virtualenv.pypa.io/en/stable/
{'fraction_non_alphanumeric': 0.1368909512761021, 'fraction_numerical': 0.0, 'mean_word_length': 3.6714801444043323, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, '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': '6583331', 'n_tokens_mistral': 356, 'n_tokens_neox': 349, 'n_words': 121}