]> git.madduck.net Git - etc/taskwarrior.git/blobdiff - docs/index.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:

Merge branch 'master' of github.com:robgolding63/tasklib
[etc/taskwarrior.git] / docs / index.rst
index 8b6b458fe7588089e71c687e145169d01dcc3759..9a86f1c4ab5bade5ffe63237b09cecd178fc49f8 100644 (file)
@@ -1,6 +1,12 @@
 Welcome to tasklib's documentation!
 ===================================
 
+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 or 2.3.0 beta2.
+Older versions of taskwarrior are untested and probably won't work.
+
 Requirements
 ------------
 
@@ -122,3 +128,5 @@ To mark a task as complete, use ``done()``::
     >>> task.done()
     >>> len(tw.tasks.pending().filter(tags__contain='work'))
     0
+
+.. _taskwarrior: http://taskwarrior.org