X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/e17985e0d4a7ce2eb83c580c71e2f7c1af7f093b..de0d843d5b31a9b2c8e78819020a59d252e18e39:/README.rst diff --git a/README.rst b/README.rst index 6cf60d6..731241c 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,22 @@ tasklib ======= -A Python library for interacting with taskwarrior_ databases. +.. image:: https://travis-ci.org/robgolding63/tasklib.png?branch=develop + :target: http://travis-ci.org/robgolding63/tasklib + +.. image:: https://coveralls.io/repos/robgolding63/tasklib/badge.png?branch=develop + :target: https://coveralls.io/r/robgolding63/tasklib?branch=develop + +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 ------------ -Before installing ``tasklib``, you'll need to install taskwarrior_. +* taskwarrior_ v2.1.x or above. Installation ------------ @@ -18,17 +28,26 @@ Install via pip:: Usage ----- -.. source-code: +tasklib has a similar API to that of Django's ORM:: - >>> from tasklib.task import TaskWarrior, PENDING + >>> from tasklib import TaskWarrior >>> tw = TaskWarrior('/home/rob/.task') - >>> tasks = tw.get_tasks(status=PENDING) + >>> tasks = tw.tasks.pending() >>> tasks ['Tidy the house', 'Learn German'] + >>> tasks.filter(tags__contain='chores') + ['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/