]> git.madduck.net Git - etc/taskwarrior.git/blobdiff - README.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Temporarily remove tasklib v2.4.0beta2 from tested versions
[etc/taskwarrior.git] / README.rst
index feb5f705bc1da034a9df4711d897aa9147daa0fe..c8053ef90574233ed011e79060d01e428e54cdac 100644 (file)
@@ -4,16 +4,16 @@ tasklib
 .. image:: https://travis-ci.org/robgolding63/tasklib.png
     :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.
+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 and 3.3 with taskwarrior 2.2.0. Older versions of
-taskwarrior are untested and probably won't work.
+Supports Python 2.6, 2.7, 3.2, 3.3 and 3.4 with taskwarrior 2.1.x and 2.2.x.
+Older versions of taskwarrior are untested and may not work.
 
 Requirements
 ------------
 
-* taskwarrior_ v2.2.0
+* taskwarrior_ v2.1.x or v2.2.x
 
 Installation
 ------------
@@ -25,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
 
@@ -38,24 +38,13 @@ Usage
     >>> type(tasks[0])
     <class 'tasklib.task.Task'>
     >>> 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/