pymtodo 0.2

Pymtodo
=================

=================
Table of contents
=================

- `Description`_

- `Installing`_

- `Quick start`_

#. `Authorizing`_

#. `Get lists and tasks`_

#. `Create lists and tasks`_

#. `Delete lists and tasks`_

- `Documentation`_

- `Disclaimer`_

- `License`_

============
Description
============

Pymtodo is an unofficial Microsoft To-Do python library which allows managing your tasks. It can help you to optimize
your workflow and create long lists (for example, if you read books and like to check it in your To-Do list).

============
Installing
============

You can install pymtodo via pip:

.. code:: shell

$ git clone https://github.com/efiminem/pymtodo.git
$ pip install pymtodo

============
Quick start
============

-------------------
Authorizing
-------------------

Pymtodo is very easy to use. First, you need to be authorized in the Microsoft To-Do system:

.. code:: python

from pymtodo import ToDoConnection
from getpass import getpass

a = ToDoConnection()
a.connect(email = 'your-email@gmail.com', password = getpass())

Getpass package allows you to write your password in the secure way, so noone will see it. Alternatively, you
can just type it directly.

-------------------
Get lists and tasks
-------------------

In order to get all your lists you can just type:

.. code:: python

a.lists

To get the tasks for the particular list, you can write:

.. code:: python

a.lists[0].tasks

-----------------------
Create lists and tasks
-----------------------

You can create lists by using

.. code:: python

a.create_list("New list")

and new tasks can be created in the particluar list:

.. code:: python

a.lists[0].create_task("New task")

-----------------------
Delete lists and tasks
-----------------------

You can delete your lists and tasks by the delete method:

.. code:: python

a.lists[0].delete()
a.lists[0].tasks[0].delete()

Be careful, there will not be a warning message.

==============
Documentation
==============

Detailed documentation will be available soon.

============
Disclaimer
============

Pymtodo is an unofficial, open source, third-party, free app and is not affiliated in any way with Microsoft.

============
License
============

Pymtodo is distributed under the MIT `license
<https://github.com/efiminem/pymtodo/blob/master/LICENSE>`_.