Markdown Task Notes for Taskwarrior

This is a simple python package that allows to add markdown notes to Taskwarrior tasks.

Installation

PiP

$ git clone https://github.com/Jimmy2027/TaskNote.git
$ cd TaskNote
$ pip install .

Portage

The package is made available in a portage overlay.

root@host $ emerge tasknote

Setup

To change defaults, write a tasknote.toml file to ~/.config/tasknote.toml, for instance by starting from tasknote.toml.example file.

# ~/.config/tasknote.toml
notes_dir = "~/.local/share/tasknotes"
task_command = "task"
editor = ["vim","+"]
default_behavior = "edit" # or "view"
note_mark = "[N]"
# note_mark = "🗒"  # unicode if your terminal supports it

Usage

$ tasknote --help
Usage: tasknote [OPTIONS] [TASK_ID]

  Console script for tasknote.

Options:
  -e, --edit         edit existing note
  -v, --view         view existing note
  -c, --config TEXT  path to configuration file  [default:
                     ~/.config/tasknote.toml]
  -a, --all          also list tasks that are completed
  --help             Show this message and exit.

Example usage

Creating 2 tasks to work on.

$ task add this is my first task
Created task 1.
$ task add this is my second task
Created task 2.
$ task

ID Age  Description            Urg 
 1 2s   this is my first task     0
 2 1s   this is my second task    0

2 tasks

Calling tasknote on task 1. Since no note exists, it is created. A mark is added to the task's description.

$ tasknote 1
## editor is run here to edit note for task 1
Modifying task 1 '[N] this is my first task'.
Modified 1 task.
$ task

ID Age   Description               Urg 
 1 16s   [N] this is my first task    0
 2 15s   this is my second task       0

2 tasks

Now there are two cases:

Default behavior is edit (default)

Being in this case means there is no default_behavior in the configuration file or the entry is set to edit.

Calling tasknote again on the same task will edit it again.

If you want to render it as markdown on the console, use the --view or -v option.

$ tasknote 1 -v

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃                 description: this is my first task                   ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛


                             First section                              

Hello, this is an example.                                              

 • point 1                                                              
 • point 2      

Default behavior is view

Being in this case means the default_behavior entry is set to view in the configuration file.

$ tasknote 1

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃                 description: this is my first task                   ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛


                             First section                              

Hello, this is an example.                                              

 • point 1                                                              
 • point 2      

To edit it again, use the --edit or -e flag.

$ tasknote 1 -e

Other options

Given no arguments, tasknote will display the list of pending tasks with a note.

$ tasknote

ID Age   Description                   Urg 
 1 41s   [N] this is my first task        0

1 task
$ task 1 done
Completed task 1 '[N] this is my first task'.
Completed 1 task.
$ tasknote
No matches.

To get the completed tasks too, use the --all or -a flag.

$ tasknote -a

ID St UUID     Age   Done Description              
 - C  ee03aec6 50s   7s   [N] this is my first task