<commit_before>.. pysharedutils documentation master file, created by
   sphinx-quickstart on Mon Sep 19 15:25:05 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pysharedutils's documentation!
=========================================

Contents:

.. toctree::
   :maxdepth: 2



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
<commit_msg>Add index docs<commit_after>================================
pysharedutils User Documentation
================================

pysharedutils
=============
`pysharedutils` is a convenient utility module which are not included in standard Python install.


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

pysharedutils is available on PyPI, so to use it you can use :program:`pip`:

To install pysharedutils, simply run::

    $ pip install pysharedutils

Alternatively, if you don't have setuptools installed, `download it from PyPi <https://pypi.python.org/pypi/pysharedutils>`_ and run::

    $ python setup.py install

Also, you can get the source from `GitHub <https://github.com/joeljames/py-shared-utils>`_ and install it as above::

    $ git clone https://github.com/joeljames/py-shared-utils.git
    $ cd pysharedutils
    $ python setup.py install


Contribute
----------
Always looking for contributions, additions and improvements.

The source is available on `GitHub <https://github.com/joeljames/py-shared-utils>`_
and contributions are always encouraged.

To contribute, fork the project on
`GitHub <https://github.com/joeljames/py-shared-utils>`_ and submit a pull request. If you have notices bugs or issues with the library, you can add it to the `Issue Tracker <https://github.com/joeljames/py-shared-utils/issues>`_.

Install development requirements. It is highly recommended that you use a `virtualenv <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_, and activate the virtualenv before installing the requirements.

Install project requirements::

    $ pip install -r requirements.txt

Run tests with coverage::

    $ make unit_test

Run test Using Tox (Runs the tests in different supported python interpreter)::

    $ tox

Run Lint::

    $ make lint

Create a new local branch to submit a pull request::

    $ git checkout -b name-of-feature

Commit your changes::

    $ git commit -m "Detailed commit message"

Push up your changes::

    $ git push origin name-of-feature

Submit a pull request. Before submitting a pull request, make sure pull request add the functionality, it is tested and docs are updated.
{'fraction_non_alphanumeric': 0.1371494429504418, 'fraction_numerical': 0.004994237418363427, 'mean_word_length': 4.146245059288537, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5781117', 'n_tokens_mistral': 751, 'n_tokens_neox': 710, 'n_words': 286}