<commit_before>PyTodoist |release| Documentation
=================================

Overview
--------
**PyTodoist** is a Python package that provides simple methods for interacting with the `Todoist <http://www.todoist.com>`_. It hides the underlying web API calls with higher-level abstractions that make it easy to use Todoist with Python.

Examples
--------

>>> from pytodoist import todoist
>>> user = todoist.login('<EMAIL>', 'passwd')
>>> user.full_name
'<NAME>'
>>> user.is_logged_in()
True
>>> projects = user.get_projects()
>>> for project in projects:
...     print project.name
...
Inbox

Install
-------

The package is hosted on `The Python Package Index <https://pypi.python.org/pypi>`_ and can be installed using `pip <https://pypi.python.org/pypi/pip>`_:

.. code-block:: bash

   $ pip install pytodoist

To install a specific version:

.. code-block:: bash

   $ pip install pytodoist==1.0

To install from source:

.. code-block:: bash

   $ git clone git://github.com/Garee/PyTodoist.git
   $ cd PyTodoist
   $ python setup.py install

Modules
-------
:doc:`todoist`
    Abstracts the underlying API and provides an easy way to interact with Todoist.

:doc:`api`
    A direct wrapper over the Todoist API.

Issues<commit_msg>Updated version number in one of the doc install examples.<commit_after>PyTodoist |release| Documentation
=================================

Overview
--------
**PyTodoist** is a Python package that provides simple methods for interacting with the `Todoist <http://www.todoist.com>`_. It hides the underlying web API calls with higher-level abstractions that make it easy to use Todoist with Python.

Examples
--------

>>> from pytodoist import todoist
>>> user = todoist.login('<EMAIL>', 'passwd')
>>> user.full_name
'<NAME>'
>>> user.is_logged_in()
True
>>> projects = user.get_projects()
>>> for project in projects:
...     print project.name
...
Inbox

Install
-------

The package is hosted on `The Python Package Index <https://pypi.python.org/pypi>`_ and can be installed using `pip <https://pypi.python.org/pypi/pip>`_:

.. code-block:: bash

   $ pip install pytodoist

To install a specific version:

.. code-block:: bash

   $ pip install pytodoist==0.5

To install from source:

.. code-block:: bash

   $ git clone git://github.com/Garee/PyTodoist.git
   $ cd PyTodoist
   $ python setup.py install

Modules
-------
:doc:`todoist`
    Abstracts the underlying API and provides an easy way to interact with Todoist.

:doc:`api`
    A direct wrapper over the Todoist API.

Issues
{'fraction_non_alphanumeric': 0.15648403626330312, 'fraction_numerical': 0.0015766653527788726, 'mean_word_length': 3.556552962298025, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 49, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, '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': '4472793', 'n_tokens_mistral': 810, 'n_tokens_neox': 769, 'n_words': 268}