SerializingObject: Create a common ancestor for Task and TaskFilter, since both need...

[etc/taskwarrior.git] / README.rst

diff --git a/README.rst b/README.rst
index ee748c2f12ec6ac70d2bb129455bb3c60449d4a6..b0a3e3453971b7fdb147b26db04097dd28848232 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,12 +1,19 @@
 tasklib
 =======
 
 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
 ------------
 
 
 Requirements
 ------------
 

-Before installing ``tasklib``, you'll need to install taskwarrior_.
+* taskwarrior_ v2.1.x or above.

 
 Installation
 ------------
 
 Installation
 ------------


@@ -18,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
 


@@ -31,24 +38,13 @@ Usage
     >>> type(tasks[0])
     <class 'tasklib.task.Task'>
     >>> task[0].done()
     >>> 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
 
 .. _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/