<commit_before>Transfluent API Client for Python
=================================

|build status|_

.. |build status| image:: https://secure.travis-ci.org/jpvanhal/python-transfluent.png?branch=master
   :alt: Build Status
.. _build status: http://travis-ci.org/jpvanhal/python-transfluent

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

::

    $ pip install transfluent

Usage
-----

.. code-block:: python

    import transfluent

    # Initialize the Transfluent client and retrieve your authentication
    # token by using your email and password.
    client = transfluent.Transfluent()
    client.authenticate(email='<EMAIL>', password='<PASSWORD>')

    # Alternatively, you may initialize the Transfluent client directly
    # with your authentication token.
    client = transfluent.Transfluent(token='my-token')<commit_msg>Added short description about the project to README.<commit_after>Transfluent API Client for Python
=================================

|build status|_

.. |build status| image:: https://secure.travis-ci.org/jpvanhal/python-transfluent.png?branch=master
   :alt: Build Status
.. _build status: http://travis-ci.org/jpvanhal/python-transfluent

This is a Python wrapper for the `Transfluent API <http://transfluent.com/backend-api/>`_.

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

::

    $ pip install transfluent

Usage
-----

.. code-block:: python

    import transfluent

    # Initialize the Transfluent client and retrieve your authentication
    # token by using your email and password.
    client = transfluent.Transfluent()
    client.authenticate(email='<EMAIL>', password='<PASSWORD>')

    # Alternatively, you may initialize the Transfluent client directly
    # with your authentication token.
    client = transfluent.Transfluent(token='my-token')
{'fraction_non_alphanumeric': 0.15179079022171688, 'fraction_numerical': 0.0, 'mean_word_length': 3.8753462603878117, 'pattern_counts': {'":': 0, '<': 8, '<?xml version=': 0, '>': 8, 'https://': 2, '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': '3244021', 'n_tokens_mistral': 502, 'n_tokens_neox': 485, 'n_words': 134}