Terminal Task Tracker

🚀 终端任务追踪器

终端任务追踪器是一个基于终端的任务跟踪应用程序，采用三窗格布局，可高效管理和规划项目任务，帮助用户提升工作效率。

🚀 快速开始

你可以按照以下步骤安装和使用终端任务追踪器：

# 克隆仓库
git clone https://github.com/yourusername/terminal-task-tracker.git
cd terminal-task-tracker

# 安装依赖项
pip install -e .

启动终端界面：

python -m main.py

✨ 主要特性

• 三窗格终端界面：
  • 任务列表（左上）
  • 任务详细信息（右上）
  • 项目计划（底部，全宽）
• 任务管理：
  • 创建、查看、编辑和删除任务
  • 设置优先级和状态
  • 添加详细描述
• 项目计划管理：
  • 定义高层次的项目步骤
  • 跟踪步骤完成情况
  • 重新排序步骤
• 完整API用于程序访问
• 命令行接口用于脚本编写
• 数据持久化

📦 安装指南

# 克隆仓库
git clone https://github.com/yourusername/terminal-task-tracker.git
cd terminal-task-tracker

# 安装依赖项
pip install -e .

💻 使用示例

基础用法

终端界面

启动终端界面：

python -m main.py

键盘绑定：

• Tab：在窗口之间切换
• Up/Down：导航列表
• Enter：选择任务（在任务列表中）
• n：新建项（在任务列表或计划中）
• e：编辑项
• d：删除项
• Space：切换完成状态（在计划中）
• Esc：退出

命令行界面

CLI提供所有功能访问：

# 列出所有任务
python -m app.api.cli task list

# 添加新任务
python -m app.api.cli task add "实现功能X" --description "关于功能X的详细信息" --priority 2

# 标记计划步骤为完成
python -m app.api.cli plan toggle STEP_ID

# 导出数据到JSON
python -m app.api.cli export data.json

高级用法

API 使用方法

from app.core.task_manager import TaskManager
from app.core.plan_manager import PlanManager
from app.api.api import TaskTrackerAPI

# 初始化管理器
task_manager = TaskManager("tasks.json")
plan_manager = PlanManager("plan.json")

# 创建API
api = TaskTrackerAPI(task_manager, plan_manager)

# 添加任务
task = api.add_task("实现功能X", "关于功能X的详细信息", priority=2)

# 添加计划步骤
step = api.add_plan_step("为共享操作模块设计架构")

# 标记步骤为完成
api.toggle_plan_step(step["id"])

# 保存数据
api.save_all()

📚 详细文档

项目结构

terminal-task-tracker/
├── app/
│   ├── __init__.py
│   ├── core/               # 业务逻辑
│   │   ├── __init__.py
│   │   ├── task_manager.py
│   │   └── plan_manager.py
│   ├── ui/                 # 终端UI
│   │   ├── __init__.py
│   │   ├── terminal_ui.py
│   │   ├── ui_components.py
│   │   └── input_handler.py
│   └── api/                # API和CLI
│       ├── __init__.py
│       ├── api.py
│       └── cli.py
├── main.py                 # 应用程序入口点
└── README.md

数据存储

默认情况下，数据保存在 ~/.tasktracker 目录中：

• tasks.json：任务数据
• plan.json：项目计划数据
• notes.json：笔记数据

📄 许可证

本项目采用 MIT 许可证。