summaryrefslogtreecommitdiffstats
path: root/python/taskw/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/taskw/README')
-rw-r--r--python/taskw/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/python/taskw/README b/python/taskw/README
new file mode 100644
index 0000000000..2aa1f078a7
--- /dev/null
+++ b/python/taskw/README
@@ -0,0 +1,9 @@
+his is a python API for the taskwarrior command line tool.
+It contains two implementations: taskw.TaskWarriorShellout
+and taskw.TaskWarriorDirect. The first implementation is the
+supported one recommended by the upstream taskwarrior core project.
+
+It uses the task export and task import commands to manipulate
+the task database. The second implementation opens the task db
+file itself and directly manipulates it. It exists for backwards
+compatibility, but should only be used when necessary.