<commit_before>***
mfr
***

**mfr** (short for "modular file renderer") is a Python package for rendering files to HTML.

.. code-block:: python

    import mfr
    import mfr_image

    # Enable the mfr_image module<commit_msg>Add README warning<commit_after>***
mfr
***

**WARNING: mfr is in a very alpha stage of development. As such, it's API is in constant flux. Expect many breaking changes.**

**mfr** (short for "modular file renderer") is a Python package for rendering files to HTML.

.. code-block:: python

    import mfr
    import mfr_image

    # Enable the mfr_image module
{'fraction_non_alphanumeric': 0.09847198641765705, 'fraction_numerical': 0.0, 'mean_word_length': 3.645669291338583, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, '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': '3976840', 'n_tokens_mistral': 181, 'n_tokens_neox': 175, 'n_words': 77}