<commit_before>Installation
============

TODO::

    pip install piquant
    pip install -r requirements.txt

.. Strongly recommend installation within a virtual environment.

Package dependencies
--------------------

TODO.
<commit_msg>Add some temporary installation instructions.<commit_after>Installation
============

.. note:: These instructions are temporary until a package has been submitted to PyPI.

.. attention:: As *piquant* has a number of dependencies on other Python packages, it is strongly recommended to install in an isolated environment using the `virtualenv http://virtualenv.readthedocs.org/en/latest/index.html`_ tool; the `virtualenvwrapper http://virtualenvwrapper.readthedocs.org/en/latest/install.html`_ makes managing multiple virtual environments easier.

Create and work in a virtual environment for *piquant* using the ``virtualenvwrapper`` tool::

    mkproject piquant

Clone the *piquant* GitHub repository into this environment::

    git clone https://github.com/lweasel/piquant.git .

Install Python packages required by *piquant*::

    pip install -r requirements.txt

Package dependencies
--------------------

TODO.

{'fraction_non_alphanumeric': 0.12241379310344827, 'fraction_numerical': 0.0, 'mean_word_length': 3.9404255319148938, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, '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': '6096945', 'n_tokens_mistral': 289, 'n_tokens_neox': 282, 'n_words': 112}