X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/4fa5c2c346fa6f0b252a76788ecfc3261a8d3647..811b104aac436b3603910d9ec8a6f3aa018f1e56:/README.rst diff --git a/README.rst b/README.rst index 23de119..731241c 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,22 @@ tasklib ======= -.. image:: https://travis-ci.org/robgolding63/tasklib.png +.. image:: https://travis-ci.org/robgolding63/tasklib.png?branch=develop :target: http://travis-ci.org/robgolding63/tasklib -A Python library for interacting with taskwarrior_ databases, using a queryset -API similar to that of Django's ORM. +.. image:: https://coveralls.io/repos/robgolding63/tasklib/badge.png?branch=develop + :target: https://coveralls.io/r/robgolding63/tasklib?branch=develop -Supports Python 2.6, 2.7, 3.2 and 3.3 with taskwarrior 2.2.0 or 2.3.0 beta2. -Older versions of taskwarrior are untested and probably won't work. +tasklib is a Python library for interacting with taskwarrior_ databases, using +a queryset API similar to that of Django's ORM. + +Supports Python 2.6, 2.7, 3.2, 3.3 and 3.4 with taskwarrior 2.1.x and above. +Older versions of taskwarrior are untested and may not work. Requirements ------------ -* taskwarrior_ v2.2.0 or v2.3.0 beta2 +* taskwarrior_ v2.1.x or above. Installation ------------ @@ -27,7 +30,7 @@ Usage tasklib has a similar API to that of Django's ORM:: - >>> from tasklib.task import TaskWarrior + >>> from tasklib import TaskWarrior >>> tw = TaskWarrior('/home/rob/.task') >>> tasks = tw.tasks.pending() @@ -37,11 +40,14 @@ tasklib has a similar API to that of Django's ORM:: ['Tidy the house'] >>> type(tasks[0]) - >>> task[0].done() + >>> tasks[0].done() >>> tasks = tw.tasks.pending() >>> tasks ['Learn German'] >>> tasks[0]['tags'] = ['languages'] >>> tasks[0].save() +For more advanced usage, see the documentation_. + .. _taskwarrior: http://taskwarrior.org +.. _documentation: http://tasklib.readthedocs.org/en/latest/