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

Add '.config/taskwarrior/hooks/task.shift-recurrence/' from commit 'd06c7ada569cc7566...
authormartin f. krafft <madduck@madduck.net>
Thu, 31 Jan 2019 02:06:20 +0000 (15:06 +1300)
committermartin f. krafft <madduck@madduck.net>
Thu, 31 Jan 2019 02:06:20 +0000 (15:06 +1300)
git-subtree-dir: .config/taskwarrior/hooks/task.shift-recurrence
git-subtree-mainline: 09f6572d50f43509715cd634b47c6e2cd5afe944
git-subtree-split: d06c7ada569cc7566c28dd48f9438849b2a88f8c

21 files changed:
.bin/task [new file with mode: 0755]
.bin/task_attach [new file with mode: 0755]
.bin/task_call [new file with mode: 0755]
.config/taskwarrior/.gitignore [new file with mode: 0644]
.config/taskwarrior/hooks/on-add-pirate [new symlink]
.config/taskwarrior/hooks/on-modify-pirate [new symlink]
.config/taskwarrior/hooks/task.shift-recurrence/.gitignore [moved from .gitignore with 100% similarity]
.config/taskwarrior/hooks/task.shift-recurrence/LICENCE [moved from LICENCE with 100% similarity]
.config/taskwarrior/hooks/task.shift-recurrence/README.md [moved from README.md with 100% similarity]
.config/taskwarrior/hooks/task.shift-recurrence/pirate_add_shift_recurrence.py [moved from pirate_add_shift_recurrence.py with 100% similarity]
.config/taskwarrior/rc [new file with mode: 0644]
.config/taskwarrior/taskpirate/LICENCE [new file with mode: 0644]
.config/taskwarrior/taskpirate/README.md [new file with mode: 0644]
.config/taskwarrior/taskpirate/on-add-pirate [new file with mode: 0755]
.config/taskwarrior/taskpirate/on-modify-pirate [new file with mode: 0755]
.crontab.d/taskwarrior [new file with mode: 0644]
.gitignore.d/taskwarrior [new file with mode: 0644]
.taskrc [new symlink]
.var/taskwarrior/.gitignore [new file with mode: 0644]
.var/taskwarrior/hooks [new symlink]
.zsh/zshrc/parts.d/50-taskwarrior [new file with mode: 0644]

diff --git a/.bin/task b/.bin/task
new file mode 100755 (executable)
index 0000000..7dd2cb4
--- /dev/null
+++ b/.bin/task
@@ -0,0 +1,12 @@
+#!/bin/sh
+set -eu
+
+CODEDIR=~/code/taskwarrior
+
+[ -d $CODEDIR/tasklib ] && export PYTHONPATH=$CODEDIR/tasklib
+
+for dir in $CODEDIR/taskwarrior/src /usr/bin; do
+  [ ! -x $dir/task ] || exec $dir/task "$@"
+done
+
+echo >&2 E: task binary not found.
diff --git a/.bin/task_attach b/.bin/task_attach
new file mode 100755 (executable)
index 0000000..efcbf4b
--- /dev/null
@@ -0,0 +1,41 @@
+#!/bin/sh
+set -eu
+
+if [ $# != 2 ]; then
+  echo >&2 E: Need exactly two arguments.
+  return 1
+fi
+
+TSK="$1"
+LINK="$2"
+
+case "$LINK" in
+  (*@*|"<*>")
+    LINK="${LINK%>}"; LINK="%{LINK#<}"
+    echo >&2 I: "Adding MsgID <$LINK> to task $TSK"
+    task "$TSK" mod data:msgid:"$LINK"
+    ;;
+
+  (*://*)
+    echo >&2 I: "Adding URL $LINK to task $TSK"
+    task "$TSK" mod data:url:"$LINK"
+    ;;
+
+  (*)
+    if [ -f "$LINK" ]; then
+
+      LINK="$(readlink -e "$LINK")"
+
+      case "$LINK" in
+        ($HOME/*) LINK="~${LINK#$HOME}";;
+      esac
+      echo >&2 I: "Adding file $LINK to task $TSK"
+      task "$TSK" mod data:file:"$LINK"
+
+    else
+      echo >&2 E: "Don't know how to handle link data $LINK"
+      return 1
+
+    fi
+    ;;
+esac
diff --git a/.bin/task_call b/.bin/task_call
new file mode 100755 (executable)
index 0000000..9f43a67
--- /dev/null
@@ -0,0 +1,42 @@
+#!/bin/sh
+set -eu
+
+if [ $# != 1 ]; then
+  echo >&2 E: Need exactly one argument.
+  return 1
+fi
+
+TSK="$1"
+
+DATA="$(task _get "$TSK".data)"
+DATATYPE="${DATA%%:*}"
+DATAPAYL="${DATA#*:}"
+
+case "$DATATYPE" in
+  ('')
+    echo >&2 I: No link data available for this task.
+    task "$TSK"
+    ;;
+
+  (msgid)
+    mutt -f =store -e "push '<search>~i $DATAPAYL'<enter>"
+    ;;
+
+  (url)
+    sensible-browser "$DATAPAYL"
+    ;;
+
+  (file)
+    if eval test -f "$DATAPAYL"; then
+      case "$(file --mime-type "$DATAPAYL")" in
+        (*": text/"*) eval sensible-editor "$DATAPAYL";;
+        (*) eval run-mailcap --action=edit "$DATAPAYL";;
+      esac
+    fi
+    ;;
+
+  (*)
+    eval run-mailcap --action=edit "$DATAPAYL"
+    ;;
+
+esac
diff --git a/.config/taskwarrior/.gitignore b/.config/taskwarrior/.gitignore
new file mode 100644 (file)
index 0000000..645470a
--- /dev/null
@@ -0,0 +1,2 @@
+- /*.pem
+- /taskd-credentials.rc
diff --git a/.config/taskwarrior/hooks/on-add-pirate b/.config/taskwarrior/hooks/on-add-pirate
new file mode 120000 (symlink)
index 0000000..88ed7b8
--- /dev/null
@@ -0,0 +1 @@
+../taskpirate/on-add-pirate
\ No newline at end of file
diff --git a/.config/taskwarrior/hooks/on-modify-pirate b/.config/taskwarrior/hooks/on-modify-pirate
new file mode 120000 (symlink)
index 0000000..006bb1e
--- /dev/null
@@ -0,0 +1 @@
+../taskpirate/on-modify-pirate
\ No newline at end of file
diff --git a/.config/taskwarrior/rc b/.config/taskwarrior/rc
new file mode 100644 (file)
index 0000000..0003703
--- /dev/null
@@ -0,0 +1,25 @@
+include /usr/share/taskwarrior/light-256.theme
+data.location=~/.var/taskwarrior
+
+nag=
+recurrence.indicator=@
+recurrence=off
+hyphenate=off
+
+color.tag.TEMPLATE=gray16 on white
+color.alternate=
+
+include /usr/share/taskwarrior/holidays.de-DE.rc
+include /usr/share/taskwarrior/holidays.en-NZ.rc
+
+include ~/.config/taskwarrior/taskd-credentials.rc
+
+uda.data.type=string
+uda.data.label=Ext.data
+uda.data.indicator=→
+
+report.next.columns=id,data.indicator,start.age,entry.age,depends,priority,project,tags,recur,scheduled.countdown,due.relative,until.remaining,description,urgency
+report.next.labels=ID,X,Active,Age,Deps,P,Project,Tag,Recur,S,Due,Until,Description,Urg
+
+alias.call=execute task_call
+alias.attach=execute task_attach
diff --git a/.config/taskwarrior/taskpirate/LICENCE b/.config/taskwarrior/taskpirate/LICENCE
new file mode 100644 (file)
index 0000000..e3e582e
--- /dev/null
@@ -0,0 +1,21 @@
+Copyright 2015-2017 Tomas Babej
+https://github.com/tbabej/taskpirate
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/.config/taskwarrior/taskpirate/README.md b/.config/taskwarrior/taskpirate/README.md
new file mode 100644 (file)
index 0000000..4d49a00
--- /dev/null
@@ -0,0 +1,57 @@
+Taskpirate
+----------
+
+Taskpirate is a pluggable system for TaskWarrior python hooks.
+
+Why?
+----
+
+Simpler hooks:
+
+    def hook_example(task):
+        task['description'] += "changed by a hook"
+
+The above is fully working example, no more boilerplate needed.
+
+Much faster execution time in case of multiple hooks (read the more details section).
+
+Install
+-------
+
+You'll need tasklib as a dependency:
+
+    pip install --user git+git://github.com/tbabej/tasklib@develop
+
+Then you need to drop ```on-add-pirate``` and ```on-modify-pirate``` into ~/.task/hooks/.
+
+After that, you can just clone any taskpirate-enabled hook as a subfolder into ~/.task/hooks/:
+
+    git clone https://github.com/tbabej/task.default-date-time ~/.task/hooks/default-date-time/
+
+How to write a taskpirate hook
+------------------------------
+
+In your hook's repository, any file matching ```pirate_add*.py``` will be searched for hooks in on-add event. In the same sense, any file matching ```pirate_mod*.py``` will be searched for hooks in on-modify event.
+
+Now, the pirate_add_example.py might look as follows:
+
+    def hook_example(task):
+        task['description'] += "changed by a hook"
+
+Any function in pirate_add_example that is called ```hook_*``` will be considered as a hook in on-add event. It will be passed the ```Task``` object corresponding to the current state of the task being added (as modified by the previous hooks).
+
+More details
+------------
+
+TaskWarrior hooks are intended to be simple, but they involve writing some boilerplate code (parsing/formatting json). To allow users to write dead simple code, they can leverage tasklib.
+
+Using tasklib simplifies things a lot, however, it's not a super-lightweight - usage of tasklib can slow down the hook by as much as 30-50ms (usual python hook can probably run in under 40ms), since it imports multiple libraries.
+
+This becomes a problem when user has multiple tasklib-based hooks, since the import time adds up.
+
+Also, note that taskpirate with arbitrary number of hooks will be most likely faster than 2-3 regular python hooks.
+
+Example hooks
+-------------
+
+You can look into my ```task.default-date-time``` or ```task.shift-recurrence``` hooks.
diff --git a/.config/taskwarrior/taskpirate/on-add-pirate b/.config/taskwarrior/taskpirate/on-add-pirate
new file mode 100755 (executable)
index 0000000..9fae1c4
--- /dev/null
@@ -0,0 +1,43 @@
+#!/usr/bin/env python
+
+import glob
+import imp
+import os
+
+from tasklib import TaskWarrior, Task
+
+
+def find_hooks(file_prefix):
+    # Find all files in subdirectories whose names start with <file_prefix>
+    file_pattern = os.path.dirname(__file__) + '/*/' + file_prefix + "*.py"
+    module_paths = [f for f in glob.glob(file_pattern) if os.path.isfile(f)]
+    module_paths.sort()
+
+    # Gather all hooks in these files
+    hooks = []
+
+    for module_path in module_paths:
+        # Load the module
+        module_dir = os.path.dirname(module_path)
+        module_filename = os.path.basename(module_path)
+        module_name = 'pirate_{0}_{1}'.format(module_dir, module_filename)
+        module_name = module_name.replace('.', '_')
+        module = imp.load_source(module_name, module_path)
+
+        # Find all hook methods available
+        module_hooks = [
+            getattr(module, hook_name)
+            for hook_name in dir(module)
+            if hook_name.startswith('hook_')
+        ]
+
+        hooks += module_hooks
+
+    return hooks
+
+task = Task.from_input()
+
+for hook in find_hooks('pirate_add'):
+    hook(task)
+
+print(task.export_data())
diff --git a/.config/taskwarrior/taskpirate/on-modify-pirate b/.config/taskwarrior/taskpirate/on-modify-pirate
new file mode 100755 (executable)
index 0000000..b7b4986
--- /dev/null
@@ -0,0 +1,43 @@
+#!/usr/bin/env python
+
+import glob
+import imp
+import os
+
+from tasklib import TaskWarrior, Task
+
+
+def find_hooks(file_prefix):
+    # Find all files in subdirectories whose names start with <file_prefix>
+    file_pattern = os.path.dirname(__file__) + '/*/' + file_prefix + "*.py"
+    module_paths = [f for f in glob.glob(file_pattern) if os.path.isfile(f)]
+    module_paths.sort()
+
+    # Gather all hooks in these files
+    hooks = []
+
+    for module_path in module_paths:
+        # Load the module
+        module_dir = os.path.dirname(module_path)
+        module_filename = os.path.basename(module_path)
+        module_name = 'pirate_{0}_{1}'.format(module_dir, module_filename)
+        module_name = module_name.replace('.', '_')
+        module = imp.load_source(module_name, module_path)
+
+        # Find all hook methods available
+        module_hooks = [
+            getattr(module, hook_name)
+            for hook_name in dir(module)
+            if hook_name.startswith('hook_')
+        ]
+
+        hooks += module_hooks
+
+    return hooks
+
+task = Task.from_input()
+
+for hook in find_hooks('pirate_mod'):
+    hook(task)
+
+print(task.export_data())
diff --git a/.crontab.d/taskwarrior b/.crontab.d/taskwarrior
new file mode 100644 (file)
index 0000000..d26dae7
--- /dev/null
@@ -0,0 +1 @@
+*/30 * * * * ( task sync && task next && task sync ) >/dev/null 2>&1
diff --git a/.gitignore.d/taskwarrior b/.gitignore.d/taskwarrior
new file mode 100644 (file)
index 0000000..b51f064
--- /dev/null
@@ -0,0 +1,18 @@
+*
+!/.bin/task
+!/.bin/task_attach
+!/.bin/task_call
+!/.config/taskwarrior/.gitignore
+!/.config/taskwarrior/hooks/on-add-pirate
+!/.config/taskwarrior/hooks/on-modify-pirate
+!/.config/taskwarrior/rc
+!/.config/taskwarrior/taskpirate/LICENCE
+!/.config/taskwarrior/taskpirate/on-add-pirate
+!/.config/taskwarrior/taskpirate/on-modify-pirate
+!/.config/taskwarrior/taskpirate/README.md
+!/.crontab.d/taskwarrior
+!/.gitignore.d/taskwarrior
+!/.taskrc
+!/.var/taskwarrior/.gitignore
+!/.var/taskwarrior/hooks
+!/.zsh/zshrc/parts.d/50-taskwarrior
diff --git a/.taskrc b/.taskrc
new file mode 120000 (symlink)
index 0000000..3113449
--- /dev/null
+++ b/.taskrc
@@ -0,0 +1 @@
+.config/taskwarrior/rc
\ No newline at end of file
diff --git a/.var/taskwarrior/.gitignore b/.var/taskwarrior/.gitignore
new file mode 100644 (file)
index 0000000..216f0fe
--- /dev/null
@@ -0,0 +1 @@
+- /*.data
diff --git a/.var/taskwarrior/hooks b/.var/taskwarrior/hooks
new file mode 120000 (symlink)
index 0000000..729b1ca
--- /dev/null
@@ -0,0 +1 @@
+../../.config/taskwarrior/hooks
\ No newline at end of file
diff --git a/.zsh/zshrc/parts.d/50-taskwarrior b/.zsh/zshrc/parts.d/50-taskwarrior
new file mode 100644 (file)
index 0000000..51d993f
--- /dev/null
@@ -0,0 +1,32 @@
+#
+# taskwarrior shell integration
+#
+# Copyright © 2018 martin f. krafft <madduck@madduck.net>
+# Released under the terms of the Artistic Licence 2.0
+#
+# Source repository: http://git.madduck.net/v/etc/zsh.git
+#
+
+if whence task >/dev/null; then
+
+  function t() { task "$@"; }
+
+  alias t\?='alias -rm t[-+a-z]'
+  alias ta='t add'
+  alias tc='t call'
+  alias th='t attach'
+  alias tn='t next'
+  alias tl='t all'
+  alias ty='t sync'
+  alias td='t done'
+  alias te='t edit'
+  alias tu='t undo'
+  alias tm='t modify'
+  alias ts='t start'
+  alias t+='t annotate'
+
+  run_at_most_every 5m \
+    t 2>/dev/null || :
+fi
+
+# vim:ft=zsh