<commit_before>README
======

Documentation at https://txtorcon.readthedocs.org

.. image:: https://travis-ci.org/meejah/txtorcon.png?branch=master
    :target: https://www.travis-ci.org/meejah/txtorcon

.. image:: https://coveralls.io/repos/meejah/txtorcon/badge.png
    :target: https://coveralls.io/r/meejah/txtorcon

.. image:: http://codecov.io/github/meejah/txtorcon/coverage.svg?branch=master
    :target: http://codecov.io/github/meejah/txtorcon?branch=master

.. image:: http://api.flattr.com/button/flattr-badge-large.png
    :target: http://flattr.com/thing/1689502/meejahtxtorcon-on-GitHub


quick start
-----------

For the impatient, there are two quick ways to install this::

   $ pip install txtorcon

... or, if you checked out or downloaded the source::

   $ python setup.py install

... or, better yet, use a virtualenv and the dev requirements::

   $ virtualenv venv
   $ ./venv/bin/pip install -e .[dev]

For OSX, we can install txtorcon with the help of easy_install::

   $ easy_install txtorcon

To avoid installing, you can just add the base of the source to your
PYTHONPATH::

   $ export PYTHONPATH=`pwd`:$PYTHONPATH

Then, you will want to explore the examples. Try "python
examples/stream\_circuit\_logger.py" for instance.
<commit_msg>add landscape.io and alt-tags<commit_after>README
======

Documentation at https://txtorcon.readthedocs.org

.. image:: https://travis-ci.org/meejah/txtorcon.png?branch=master
    :target: https://www.travis-ci.org/meejah/txtorcon
    :alt: travis

.. image:: https://coveralls.io/repos/meejah/txtorcon/badge.png
    :target: https://coveralls.io/r/meejah/txtorcon
    :alt: coveralls

.. image:: http://codecov.io/github/meejah/txtorcon/coverage.svg?branch=master
    :target: http://codecov.io/github/meejah/txtorcon?branch=master
    :alt: codecov

.. image:: http://api.flattr.com/button/flattr-badge-large.png
    :target: http://flattr.com/thing/1689502/meejahtxtorcon-on-GitHub
    :alt: flattr

.. image:: https://landscape.io/github/meejah/txtorcon/master/landscape.svg?style=flat
    :target: https://landscape.io/github/meejah/txtorcon/master
    :alt: Code Health

quick start
-----------

For the impatient, there are two quick ways to install this::

   $ pip install txtorcon

... or, if you checked out or downloaded the source::

   $ python setup.py install

... or, better yet, use a virtualenv and the dev requirements::

   $ virtualenv venv
   $ ./venv/bin/pip install -e .[dev]

For OSX, we can install txtorcon with the help of easy_install::

   $ easy_install txtorcon

To avoid installing, you can just add the base of the source to your
PYTHONPATH::

   $ export PYTHONPATH=`pwd`:$PYTHONPATH

Then, you will want to explore the examples. Try "python
examples/stream\_circuit\_logger.py" for instance.

{'fraction_non_alphanumeric': 0.13728995352163031, 'fraction_numerical': 0.0050053628888094386, 'mean_word_length': 3.5718954248366015, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 12, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3648426', 'n_tokens_mistral': 995, 'n_tokens_neox': 957, 'n_words': 232}