This is a CLI application that helps Taskwarrior users quantify their productivity by tracking the 'score' attribute in their tasks.
score is a custom User Defined Attributes. You will need to have that configured in your .taskrc file. A sample configuration for this attribute would be:
uda.score.type=numeric
uda.score.label=Score 🏆
urgency.uda.score.coefficient=2
TaskQuant will then compute the score(s) you have accumulated across the different tasks and return a scoresheet.
TaskQuant has no external dependencies except tasklib, which is also by the same organization that developed Taskwarrior.
It is written entirely in Python, using standard library. It may have optional dependencies, but those are not required and a fallback option will always be used by default.
For those reasons, TaskQuant is extremely lightweight. As it stands, it's only 6.8kb of code, and should install in under a second.
TaskQuant is available on pypi.
pip install taskquant
If you so desire, you can optionally install tabulate to get a prettier table output (this is completely optional, and pure cosmetic):
pip install tabulate
Install the package and execute:
tq
- It supports an optional
-p(path) argument to specify the path to your.taskfile. Especially helpful if you changed the default location of your.taskfile. - It supports an optional
-v(verbose) argument to print out additional information in its output.
tq -p ~/vaults/tasks -v # outputs: +------------+-------+------------+ | Date | Score | Cumulative | +------------+-------+------------+ | 2022年03月09日 | 0 | 0 | | 2022年03月10日 | 8 | 8 | | 2022年03月11日 | 1 | 9 | | 2022年03月12日 | 43 | 52 | | 2022年03月13日 | 4 | 56 | | 2022年03月14日 | 4 | 60 | | 2022年03月15日 | 7 | 67 | | 2022年03月16日 | 9 | 76 | | 2022年03月17日 | 4 | 80 | | 2022年03月18日 | 4 | 84 | | 2022年03月19日 | 3 | 87 | | 2022年03月20日 | 2 | 89 | | 2022年03月21日 | 5 | 94 | +------------+-------+------------+ Total completed tasks: 48 Active dates: 13 task_path: /home/samuel/vaults/tasks
You can also print a weekly (-w) version of the scoresheet:
tq -w +-------+-------+------------+ | Week# | Score | Cumulative | +-------+-------+------------+ | 10 | 56 | 56 | | 11 | 33 | 89 | | 12 | 26 | 115 | | 13 | 12 | 127 | +-------+-------+------------+
The first column refers to the ISO week number of the year.
- To see all optional arguments, use the
-h(help) argument.
tq -h
Tests are written in unittest and stored in the tests directory.
To execute tests without arguments and automatic test discovery:
python -m unittest
To test a specific test file (-v for verbose output):
python -m unittest -v tests/test_accum.py
test_create_combined_table (tests.test_accum.TestAccum) ... ok
test_create_full_date ... ok
test_create_table_auto (tests.test_accum.TestAccum) ... ok
test_extract_tasks (tests.test_accum.TestAccum) ... ok
test_fill_rolling_date (tests.test_accum.TestAccum) ... ok
test_invalid_path_warning (tests.test_accum.TestAccum) ... ok
test_task_to_dict (tests.test_accum.TestAccum) ... ok
----------------------------------------------------------------------
Ran 7 tests in 0.049s
OK
- Add terminal-based charts and graphs
- New ways to visualize scores based on tags, projects or other attributes
Watch how we build this package, line by line (detailed tutorial):