]> 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:

projects / etc / taskwarrior.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
TaskWarrior: Set dependency.confirmation=no by default
[etc/taskwarrior.git] / README.rst
diff --git a/README.rst b/README.rst
index 6cf60d6daf3a02b86708864baa6f726264e595db..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,17 +25,26 @@ Install via pip::
 Usage
 -----
 
 Usage
 -----
 
-.. source-code:
+tasklib has a similar API to that of Django's ORM::
 
 
-    >>> from tasklib.task import TaskWarrior, PENDING
+    >>> from tasklib.task import TaskWarrior
 
     >>> tw = TaskWarrior('/home/rob/.task')
 
     >>> tw = TaskWarrior('/home/rob/.task')
-    >>> tasks = tw.get_tasks(status=PENDING)
+    >>> tasks = tw.tasks.pending()
     >>> tasks
     ['Tidy the house', 'Learn German']
     >>> tasks
     ['Tidy the house', 'Learn German']
+    >>> tasks.filter(tags__contain='chores')
+    ['Tidy the house']
     >>> 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()
 
 
+For more advanced usage, see the documentation_.
 
 .. _taskwarrior: http://taskwarrior.org
 
 .. _taskwarrior: http://taskwarrior.org
+.. _documentation: http://tasklib.readthedocs.org/en/latest/

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.