<commit_before>************************
Scrapy Cluster Utilities
************************

Overview
--------

The ``scutils`` package is a collection of utilities that are used by the Scrapy Cluster project.  These utilities are agnostic enough that they can be used by any application.

Requirements
------------

- Unix based machine (Linux of OS X)
- Python 2.7.x

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

Inside a virtualenv, run ``pip install -U scutils``.  This will install the latest version of the Scrapy Cluster Utilities.  If you are running a Scrapy Cluster, ``scutils`` is included inside of the **requirements.txt** so there is no need to install it separately.

Documentation
-------------

Full documentation for the ``scutils`` package will be included as part of the Scrapy Cluster 1.1 release.  Basic descriptions are below.

argparse_helper.py
==================

The ``argparse_helper`` module is used to help print top level ``--help`` arguments from argparse when used with subparsers. Useful for running applications that have multiple combinations of subcommands and command line arguments.

log_factory.py<commit_msg>Fix minor typo in scutils README.rst<commit_after>************************
Scrapy Cluster Utilities
************************

Overview
--------

The ``scutils`` package is a collection of utilities that are used by the Scrapy Cluster project.  These utilities are agnostic enough that they can be used by any application.

Requirements
------------

- Unix based machine (Linux or OS X)
- Python 2.7.x

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

Inside a virtualenv, run ``pip install -U scutils``.  This will install the latest version of the Scrapy Cluster Utilities.  If you are running a Scrapy Cluster, ``scutils`` is included inside of the **requirements.txt** so there is no need to install it separately.

Documentation
-------------

Full documentation for the ``scutils`` package will be included as part of the Scrapy Cluster 1.1 release.  Basic descriptions are below.

argparse_helper.py
==================

The ``argparse_helper`` module is used to help print top level ``--help`` arguments from argparse when used with subparsers. Useful for running applications that have multiple combinations of subcommands and command line arguments.

log_factory.py
{'fraction_non_alphanumeric': 0.1459886014905743, 'fraction_numerical': 0.0035072336694432268, 'mean_word_length': 3.886509635974304, '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': '3169849', 'n_tokens_mistral': 586, 'n_tokens_neox': 540, 'n_words': 290}