]> git.madduck.net Git - etc/taskwarrior.git/commitdiff

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:

Tidy up README a little
authorRob Golding <rob@robgolding.com>
Sun, 10 Nov 2013 15:31:03 +0000 (15:31 +0000)
committerRob Golding <rob@robgolding.com>
Sun, 10 Nov 2013 15:31:03 +0000 (15:31 +0000)
README.rst

index feb5f705bc1da034a9df4711d897aa9147daa0fe..a5dcfe56122d59dcde47bab172d4060d8167e4f2 100644 (file)
@@ -25,7 +25,7 @@ Install via pip::
 Usage
 -----
 
 Usage
 -----
 
-.. source-code:
+tasklib has a similar API to that of Django's ORM::
 
     >>> from tasklib.task import TaskWarrior
 
 
     >>> from tasklib.task import TaskWarrior
 
@@ -38,24 +38,10 @@ Usage
     >>> type(tasks[0])
     <class 'tasklib.task.Task'>
     >>> task[0].done()
     >>> type(tasks[0])
     <class 'tasklib.task.Task'>
     >>> task[0].done()
-
-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
+    >>> tasks = tw.tasks.pending()
+    >>> tasks
+    ['Learn German']
+    >>> tasks[0]['tags'] = ['languages']
+    >>> tasks[0].save()
 
 .. _taskwarrior: http://taskwarrior.org
 
 .. _taskwarrior: http://taskwarrior.org
-
-Tasks can also be filtered using raw commands, like so::
-
-    >>> tw.tasks.filter('status:pending +work')
-    ['Upgrade Ubuntu Server']