<commit_before>Mistral
=======

Task Orchestration and Scheduling service for OpenStack cloud


Running in development mode
---------------------------

### Installation
First of all, in a shell run:

*tox*

This will install necessary virtual environments and run all the project tests. Installing virtual environments may take significant time (~10-15 mins).

### Running Mistral API server
To run Mistral API server perform the following command in a shell:

*tox -evenv -- python mistral/cmd/launch.py --server api --config-file path_to_config*

Note that an example configuration file can be found in etc/mistral.conf.example.

### Running Mistral Task Executors
To run Mistral Task Executor instance perform the following command in a shell:

*tox -evenv -- python mistral/cmd/launch.py --server executor --config-file path_to_config*

Note that at least one Executor instance should be running so that workflow tasks are processed by Mistral.

### Debugging
To debug using a local engine and executor without dependencies such as RabbitMQ, create etc/mistral.conf with the following settings::

    [DEFAULT]
    rpc_backend = fake

    [pecan]
    auth_enable = False

and run in pdb, PyDev or PyCharm::

    mistral/cmd/launch.py --server all --config-file etc/mistral.conf --use-debugger
<commit_msg>Improved README file<commit_after>Mistral
=======

Task Orchestration and Scheduling service for OpenStack cloud


Running in development mode
---------------------------

### Installation
First of all, in a shell run:

*tox*

This will install necessary virtual environments and run all the project tests. Installing virtual environments may take significant time (~10-15 mins).

### Running Mistral API server
To run Mistral API server perform the following command in a shell:

*tox -evenv -- python mistral/cmd/launch.py --server api --config-file path_to_config*

Note that an example configuration file can be found in etc/mistral.conf.example.

### Running Mistral Task Executors
To run Mistral Task Executor instance perform the following command in a shell:

*tox -evenv -- python mistral/cmd/launch.py --server executor --config-file path_to_config*

Note that at least one Executor instance should be running so that workflow tasks are processed by Mistral.

### Debugging
To debug using a local engine and executor without dependencies such as RabbitMQ, create etc/mistral.conf with the following settings::

    [DEFAULT]
    rpc_backend = fake

    [pecan]
    auth_enable = False

and run in pdb, PyDev or PyCharm::

    mistral/cmd/launch.py --server all --config-file etc/mistral.conf --use-debugger

### Running examples

To run the examples find them in mistral-extra repository (https://github.com/stackforge/mistral-extra) and follow the instructions on each example.

{'fraction_non_alphanumeric': 0.09003215434083602, 'fraction_numerical': 0.0028581636298678098, 'mean_word_length': 3.7377326565143822, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, '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': '1612972', 'n_tokens_mistral': 778, 'n_tokens_neox': 730, 'n_words': 341}