<commit_before>Cookies Documentation
=====================

For this project/package, we recommend using cookiecutter (along with
Flask) to set up your directory if you intend to create a web
app/interface for your project.

Cookies makes it very easy to do this.

Learn more about the
`cookiecutter <https://github.com/audreyr/cookiecutter>`__ package.

Examples
--------

The `Manager
module <https://github.com/datasnakes/OrthoEvolution/tree/master/OrthoEvol/Manager>`__
uses the *CookieRecipes* and *Oven* classes as a primary means of
functioning.

Simple Implementation
~~~~~~~~~~~~~~~~~~~~~

.. code:: python

    from OrthoEvol.Cookies import Oven

    Kitchen = Oven(repo="repo", user="user", project="project", output_dir="project_path")
    Pantry = Kitchen.Ingredients
    Kitchen.bake_the_*()<commit_msg>Updated CookieRecipes class in docs to CookBook.<commit_after>Cookies Documentation
=====================

For this project/package, we recommend using cookiecutter (along with
Flask) to set up your directory if you intend to create a web
app/interface for your project.

Cookies makes it very easy to do this.

Learn more about the
`cookiecutter <https://github.com/audreyr/cookiecutter>`__ package.

Examples
--------

The `Manager
module <https://github.com/datasnakes/OrthoEvolution/tree/master/OrthoEvol/Manager>`__
uses the *CookBook* and *Oven* classes as a primary means of
functioning.

Simple Implementation
~~~~~~~~~~~~~~~~~~~~~

.. code:: python

    from OrthoEvol.Cookies import Oven

    Kitchen = Oven(repo="repo", user="user", project="project", output_dir="project_path")
    Pantry = Kitchen.Ingredients
    Kitchen.bake_the_*()
{'fraction_non_alphanumeric': 0.14362980769230768, 'fraction_numerical': 0.0, 'mean_word_length': 4.821678321678322, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 4, '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': '3084086', 'n_tokens_mistral': 516, 'n_tokens_neox': 482, 'n_words': 157}