<commit_before>.. :usage:

=======
Install
=======

::

    pip install python-taiga


=====================
Getting Started
=====================

Getting started with the Taiga API couldn't be easier: create a ``TaigaAPI`` and you're ready to go.

.. note:: python-taiga is a python wrapper for the `Taiga REST API <http://taigaio.github.io/taiga-doc/dist/api.html>`_.
          Any data structure, argument and response matches exactly the Taiga REST API, so refer to it for any usage.


*********************
API Credentials
*********************

The ``TaigaAPI`` needs your Taiga credentials. You can pass these
directly to the auth method (see the code below).

.. code:: python

    from taiga import TaigaAPI

    api = TaigaAPI()

    api.auth(
        username='user',
        password='<PASSWORD>'
    )

Alternately, you can pass a token to the constructor ``TaigaAPI``
constructor.

.. code:: python

    from taiga import TaigaAPI

    api = TaigaAPI(token='my<PASSWORD>')

You can also specify a different host if you use Taiga somewhere else

.. code:: python

    from taiga import TaigaAPI

    api = TaigaAPI(
        host='http://taiga.my.host.org'
    )

To use LDAP or other authentication backends, user ``auth_type`` argumento

.. code:: python

    from taiga import TaigaAPI

    api = TaigaAPI(
        host='http://taiga.my.host.org',
        auth_type='ldap'
    )

To ignore SSL certificate verification (use at your own risk!) use ``tls_verify`` argument

.. code:: python

    from taiga import TaigaAPI

    api = TaigaAPI(
        host='http://taiga.my.host.org',
        tls_verify=False
    )
<commit_msg>Fix typo in documentation (#108)<commit_after>.. :usage:

=======
Install
=======

::

    pip install python-taiga


=====================
Getting Started
=====================

Getting started with the Taiga API couldn't be easier: create a ``TaigaAPI`` and you're ready to go.

.. note:: python-taiga is a python wrapper for the `Taiga REST API <http://taigaio.github.io/taiga-doc/dist/api.html>`_.
          Any data structure, argument and response matches exactly the Taiga REST API, so refer to it for any usage.


*********************
API Credentials
*********************

The ``TaigaAPI`` needs your Taiga credentials. You can pass these
directly to the auth method (see the code below).

.. code:: python

    from taiga import TaigaAPI

    api = TaigaAPI()

    api.auth(
        username='user',
        password='<PASSWORD>'
    )

Alternately, you can pass a token to the constructor ``TaigaAPI``
constructor.

.. code:: python

    from taiga import TaigaAPI

    api = TaigaAPI(token='<PASSWORD>')

You can also specify a different host if you use Taiga somewhere else

.. code:: python

    from taiga import TaigaAPI

    api = TaigaAPI(
        host='http://taiga.my.host.org'
    )

To use LDAP or other authentication backends, use ``auth_type`` argument

.. code:: python

    from taiga import TaigaAPI

    api = TaigaAPI(
        host='http://taiga.my.host.org',
        auth_type='ldap'
    )

To ignore SSL certificate verification (use at your own risk!) use ``tls_verify`` argument

.. code:: python

    from taiga import TaigaAPI

    api = TaigaAPI(
        host='http://taiga.my.host.org',
        tls_verify=False
    )

{'fraction_non_alphanumeric': 0.1524704455895726, 'fraction_numerical': 0.0009093664746892998, 'mean_word_length': 3.0892193308550184, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, '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': '3656721', 'n_tokens_mistral': 1025, 'n_tokens_neox': 948, 'n_words': 348}