todoq 1.0.12

Simplest command-line TODO list

# TodoQ

The simplest command-line todo list to help you focused better at work.

## Introduction

TodoQ is a single-task-display, priority-based, command-line todo list (I don’t know whether someone has come up with such a concept as single-task display).

“Single-task-display” means that usually it only displays the top task, and you can “finish”, “drop” or “postpone” it.

“Priority-based” means the order of tasks is totally based on priority, which is an unsigned int (whichever python int type supports).

“Command-line” means it is run by linux / unix (mac included) terminal.

TodoQ also supports multiple queues, in case you want to work in multiple threads at the same time in a period.

We also support the sync of tasks, and dropbox account is required if you want to use the feature.

## The story behind the design of TodoQ

We hope to design the world’s simplest command-line todo list, and we have two basic goals for it:

1. The todo list should help users focus on work.

2. The task management overhead should be minimized.

Personally I am a todo list enthusiast. Starting from paper and pencil when I was in high school, I have been trying to use todo list to help me schedule my life. I explored and used different methods and tools to help me track the status of daily tasks. Some of the tools are pretty cool, and I actually used them for quite while. But from my experience, I found that I never kept using a single tool for more than two weeks. At first, I might be attracted to a tool and make up my mind for a resolution to make my life well-planed. But soon I found that the tool does not actually help me much on focus and getting things done, but the overhead to manage the todo list itself is pretty high.

Now as a research assistant, a side-project developer and a student at the same time. I use command-line tools quite a lot every day. Sometimes I use web-based todo list to help me track problems to solve, features to implement, or bugs to fix. But switching between command line and browser can be a pain sometimes, and looks less professional. Such a switching could also be distracting sometimes.

Then my friends and I decide to write a todo list tool for developers like us, basically command-line everything guys =). We hope it could be really light-wight, “prevent” over-managing task list, and help focus on work. So we come up with the idea of single-task display todo list. Instead of displaying all the tasks, we simply show the top one, the one with the highest priority. Operations, like “finish”, “drop”, “postpone”, are only limited to the top one to minimize the todo list management overhead. Tasks can still be listed with the command “peek”, which is highly not recommended. We hope users could just focus on the top task at the moment, and thinking about other tasks only when absolutely necessary.

You may find such a design may be inconvenient sometimes. You may want to arrange the order of tasks, set a deadline for it, or simply drop some of them. These operations are almost unsupported in TodoQ. Instead, for the order, we use priority (basically any unsigned int number between 0 and whatever python int type supports). The tasks are ordered based on priority completely. We don’t use deadline for tasks. We believe that human mind should be able to transform urgency to priority easily, and for work, a good way to meet a deadline is to do it as early as possible. You may want to drop some of tasks since you have finished them, or they are not necessary any more, but why not do it later, cause managing todo list itself could also be “viewed” as a task with not-the-highest priority.

We hope you could enjoy using TodoQ, and make it help you improve your valuable productivity.

## Install

First-time install:

sudo pip install todoq

Update:

sudo pip install todoq -U

Uninstall:

sudo pip uninstall todoq

## Usage

### Add a new task

todoq add task_name [priority]

Add a task into the current queue with the specified priority.

Example #1

todoq add “finish the front page UI design” 999

task name - finish the front page UI design priority - 999

Example #2

todoq add “check email”

task name - check email priority - 17 (default priority value)

### Show the top task

todoq top

Display the top task. Yes, you are right, just the top one task.

### Finish the top task

todoq finish

Mark the top task as “finished”.

### Postpone the top task

todoq postpone [priority]

If priority is specified, the top task is postponed with the new priority. Otherwise, the top task is postponed after the second task.

### Drop the top task

todoq drop

Mark the top task as “dropped”.

### Show the complete task list

todoq ls

List all the tasks in the current queue. The sub-command should be used rarely to avoid distraction.

Options

-u: list all the unfinished tasks -a: list all the tasks -f: list all the finished tasks -d: list all the dropped tasks -n count: specifiy the number of tasks to be displayed

### Show all the task queues

todoq showq

List all the queues. Single queue is recommended. Multiple queues are provided in case you have multiple projects at hand.

### Select a task queue

todoq selectq queue_name

Select the queue as the current queue.

### Create a new task queue

todoq createq queue_name

Create a new queue.

### Delete a task queue

todoq deleteq queue_name

Delete an existing queue.

### Show usage

todoq –help, todoq -h, todoq help

Show help. Any “unexpected” command will also lead to help.

## License

Apache license is applied if you want to use the source code. [http://www.apache.org/licenses/LICENSE-2.0]( http://www.apache.org/licenses/LICENSE-2.0)