<commit_before>Expects docs Mamba formatter
============================

`Mamba <https://github.com/nestorsalceda/mamba>`_ formatter to build the `Expects <https://github.com/jaimegildesagredo/expects>`_ docs.

Installation
------------

You can install it directly from github::

    $ git clone git://github.com/jaimegildesagredo/expects_docs_mamba_formatter.git
    $ cd expects_docs_mamba_formatter
    $ python setup.py install
    $ pip install -r requirements.txt

Usage
-----

Once installed you can run the `Expect specs <https://github.com/jaimegildesagredo/expects#specs>`_ with mamba and the installed formatter to generate the examples in `RST <http://sphinx-doc.org/rest.html>`_ format::

    $ cd expects
    $ mamba spec/expects --format=expects_docs > docs/expectations.rst<commit_msg>Fixed expects name in readme<commit_after>Expects docs Mamba formatter
============================

`Mamba <https://github.com/nestorsalceda/mamba>`_ formatter to build the `Expects <https://github.com/jaimegildesagredo/expects>`_ docs.

Installation
------------

You can install it directly from github::

    $ git clone git://github.com/jaimegildesagredo/expects_docs_mamba_formatter.git
    $ cd expects_docs_mamba_formatter
    $ python setup.py install
    $ pip install -r requirements.txt

Usage
-----

Once installed you can run the `Expects specs <https://github.com/jaimegildesagredo/expects#specs>`_ with mamba and the installed formatter to generate the examples in `RST <http://sphinx-doc.org/rest.html>`_ format::

    $ cd expects
    $ mamba spec/expects --format=expects_docs > docs/expectations.rst
{'fraction_non_alphanumeric': 0.14549938347718866, 'fraction_numerical': 0.0, 'mean_word_length': 4.1198738170347005, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 13, 'https://': 6, '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': '6901998', 'n_tokens_mistral': 531, 'n_tokens_neox': 502, 'n_words': 129}