README.rst

   1 tasklib
   2 =======
   3
   4 A Python library for interacting with taskwarrior_ databases.
   5
   6 Requirements
   7 ------------
   8
   9 Before installing ``tasklib``, you'll need to install taskwarrior_.
  10
  11 Installation
  12 ------------
  13
  14 Install via pip::
  15
  16     pip install tasklib
  17
  18 Usage
  19 -----
  20
  21 .. source-code:
  22
  23     >>> from tasklib.task import TaskWarrior
  24
  25     >>> tw = TaskWarrior('/home/rob/.task')
  26     >>> tasks = tw.tasks.pending()
  27     >>> tasks
  28     ['Tidy the house', 'Learn German']
  29     >>> tasks.filter(tags__contain='chores')
  30     ['Tidy the house']
  31     >>> type(tasks[0])
  32     <class 'tasklib.task.Task'>
  33     >>> task[0].done()
  34
  35 Filtering Tasks
  36 ---------------
  37
  38 Tasks can be filtered using the ``TaskQuerySet`` API which emulates the
  39 Django ORM::
  40
  41     >>> tw.tasks.filter(status='pending', tags__contain='work')
  42     ['Upgrade Ubuntu Server']
  43
  44 Filter arguments are passed to the ``task`` command (``__`` is replaced by
  45 a period); so the above example is equivalent to the following command::
  46
  47     $ task status:pending tags.contain=work
  48
  49 .. _taskwarrior: http://taskwarrior.org