GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - onlyphantom/taskquant: A python CLI that extends taskwarrior for productivity scoreboard & gamification (quantified self)

BranchesTags
Open more actions menu

Latest commit

 

History

13 Commits
13 Commits

Folders and files

NameName
Last commit message
Last commit date
taskquant
taskquant
 
 
tests
tests
 
 
.gitignore
.gitignore
 
 
CHANGELOG
CHANGELOG
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
requirements.txt
requirements.txt
 
 
setup.py
setup.py
 
 

Repository files navigation

TaskQuant

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.

Installation

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

Usage

Install the package and execute:

tq 
  • It supports an optional -p (path) argument to specify the path to your .task file. Especially helpful if you changed the default location of your .task file.
  • 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

Dependencies

  • tasklib
  • (Optional) tabulate

Testing

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

Roadmap

  • Add terminal-based charts and graphs
  • New ways to visualize scores based on tags, projects or other attributes

Links to Tutorials

Watch how we build this package, line by line (detailed tutorial):

  • Building TaskQuant | Part 1
  • Taskwarrior: Terminal-based task management Quick Tour
  • Building TaskQuant | Full Playlist
  • Dev.to article: Todo + gamification with Taskwarrior & Taskquant

About

A python CLI that extends taskwarrior for productivity scoreboard & gamification (quantified self)

Topics

clitaskwarrior2

Resources

Readme
MIT license
Activity

Stars

23 stars

Watchers

1 watching

Forks

2 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.