<commit_before>####
List
####<commit_msg>add list autofucnt to list.rst, and add usage<commit_after>####
List
####

.. autofunction:: parsenvy.parsenvy.list


Usage
-----

.. code-block:: shell

    export LIST_ENV_VAR=1,2,3

.. code-block:: python

    >>> import parsenvy
    >>> parsenvy.list('LIST_ENV_VAR')
    (1,2,3)
{'fraction_non_alphanumeric': 0.19504643962848298, 'fraction_numerical': 0.018575851393188854, 'mean_word_length': 3.563380281690141, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, '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': '3265102', 'n_tokens_mistral': 130, 'n_tokens_neox': 122, 'n_words': 24}