X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/5f02f81952c8267636cc57e977dc5d257320129f..bc24f9ebe350e46d9e54969f0852e7bda4be16c5:/README.rst?ds=sidebyside diff --git a/README.rst b/README.rst index ee748c2..b0a3e34 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,19 @@ tasklib ======= -A Python library for interacting with taskwarrior_ databases. +.. image:: https://travis-ci.org/robgolding63/tasklib.png + :target: http://travis-ci.org/robgolding63/tasklib + +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,7 +25,7 @@ Install via pip:: Usage ----- -.. source-code: +tasklib has a similar API to that of Django's ORM:: >>> from tasklib.task import TaskWarrior @@ -31,24 +38,13 @@ Usage >>> type(tasks[0]) >>> task[0].done() + >>> tasks = tw.tasks.pending() + >>> tasks + ['Learn German'] + >>> tasks[0]['tags'] = ['languages'] + >>> tasks[0].save() -Filtering Tasks ---------------- - -Tasks can be filtered using the ``TaskQuerySet`` API which emulates the -Django ORM:: - - >>> tw.tasks.filter(status='pending', tags__contain='work') - ['Upgrade Ubuntu Server'] - -Filter arguments are passed to the ``task`` command (``__`` is replaced by -a period); so the above example is equivalent to the following command:: - - $ task status:pending tags.contain=work +For more advanced usage, see the documentation_. .. _taskwarrior: http://taskwarrior.org - -Tasks can also be filtered using raw commands, like so:: - - >>> tw.tasks.filter('status:pending +work') - ['Upgrade Ubuntu Server'] +.. _documentation: http://tasklib.readthedocs.org/en/latest/