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, PENDING
  24
  25     >>> tw = TaskWarrior('/home/rob/.task')
  26     >>> tasks = tw.get_tasks(status=PENDING)
  27     >>> tasks
  28     ['Tidy the house', 'Learn German']
  29     >>> type(tasks[0])
  30     <class 'tasklib.task.Task'>
  31     >>> task[0].done()
  32
  33
  34 .. _taskwarrior: http://taskwarrior.org