todo-cmd 1.0.1

                                                   __
 __________  ____  ____        _________ ___  ____/ /
/_  __/ __ \/ __ \/ __ \______/ ___/ __ `__ \/ __  / 
 / / / /_/ / /_/ / /_/ /_____/ /__/ / / / / / /_/ /  
/_/  \____/_____/\____/      \___/_/ /_/ /_/\__,_/   
                         

欢迎使用 todo-cmd，这是一个简单的工具，帮助您在命令行中轻松管理代办、记录完成事项。中文文档在这里

Welcome to the todo-cmd! This is a simple tool to help you manage your tasks.

1. Features

1. Commandline interface, easy to use
2. Simple and beautiful TUI
3. Support multiple status: todo, done, expired, discarded
4. Support task priority: p0, p1, p2, p3

2. Installation

2.1 👍 Use uv or pipx

# if you don't have uv
pip3 install uv

# Use uv
uv tool install todo-cmd

# or use pipx
pipx install todo-cmd

uninstall

# Use uv
uv tool uninstall todo-cmd

# Use pipx
pipx uninstall todo-cmd

2.2 Install from source

git clone https://github.com/paperplane110/todo_cmd.git
cd todo_cmd
pip3 install .

3. Usage

Add a todo task

todo add ${task}

# or use shortcut
todo a ${task}

# with deadline
todo add ${task} --deadline ${YYYYMMdd}
todo add ${task} -ddl ${YYYYMMdd}

Add a finished task

todo log ${task}

# or use shortcut
todo l ${task}

List tasks

List all tasks

todo ls

┏━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┓
┃ id ┃ Status ┃ Task                                 ┃  Deadline  ┃ Finish Date ┃
┡━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━┩
│ 10 │  expr  │ Apply a card for my electric-bike    │ 2024-11-10 │      /      │
├────┼────────┼──────────────────────────────────────┼────────────┼─────────────┤
│ 9  │  todo  │ ask Liuke about perf monitor scripts │ 2024-11-13 │      /      │
├────┼────────┼──────────────────────────────────────┼────────────┼─────────────┤
│ 8  │  done  │ start a pr in rich                   │ 2024-11-12 │ 2024-11-12  │
│ 7  │  done  │ refactor template and ask            │ 2024-11-12 │ 2024-11-11  │
│ 6  │  done  │ find ICBC card                       │ 2024-11-12 │ 2024-11-12  │
│ 4  │  done  │ finish todo rm                       │ 2024-11-10 │ 2024-11-10  │
│ 3  │  done  │ go to ICBC update ID info            │ 2024-11-12 │ 2024-11-12  │
│ 1  │  done  │ add some translation                 │ 2024-11-10 │ 2024-11-10  │
└────┴────────┴──────────────────────────────────────┴────────────┴─────────────┘

List tasks by given status (todo|done|expr)

todo ls --${status}

More options: todo ls

Set a Task Done

todo done ${task_id}

Discard a Task

todo drop ${task_id}

Remove a Task

todo rm ${task_id}

Modify a Task

todo mod ${task_id}

# or use shortcut
todo m ${task_id}

More options: todo mod

Edit configuration

# show configs
todo config --list

# edit configs
todo config --edit

• More details: Configuration

4. For Developer

Install todo_cmd in editable mode

pip install -e .

5. Design

Tech stack

• Commandline: Rich-click
• TUI: Rich

Documents

• Task class
  • Task status
• Design of todo ls
• Design of todo rm
• Design of todo mod