113 lines
1.9 KiB
Markdown
113 lines
1.9 KiB
Markdown
# todo_cli
|
|
|
|
## 📖 Description
|
|
|
|
`todo_cli` 是一个命令行任务管理工具，用于通过终端快速添加、查看、完成和删除待办事项。项目采用本地存储方式保存任务数据，包含核心任务逻辑、存储模块和命令行入口。
|
|
|
|
## ✨ Features
|
|
|
|
- 任务新增
|
|
- 任务删除
|
|
- 任务编辑
|
|
- 任务完成
|
|
- 状态筛选
|
|
- 优先级排序
|
|
- 数据持久化
|
|
- 命令行交互
|
|
- 帮助信息
|
|
|
|
## 📁 Project Structure
|
|
|
|
```
|
|
todo_cli/
|
|
requirements.txt
|
|
tests/
|
|
resources/
|
|
prd/
|
|
20260606123307.md
|
|
data_api_design/
|
|
20260606123307.mmd
|
|
api_spec_and_task/
|
|
system_design/
|
|
20260606123307.md
|
|
competitive_analysis/
|
|
20260606123307.mmd
|
|
code_plan_and_change/
|
|
seq_flow/
|
|
20260606123307.mmd
|
|
sd_output/
|
|
code_summary/
|
|
graph_db/
|
|
test_outputs/
|
|
docs/
|
|
requirement.txt
|
|
prd/
|
|
20260606123307.json
|
|
task/
|
|
20260606123307.json
|
|
graph_repo/
|
|
system_design/
|
|
20260606123307.json
|
|
code_plan_and_change/
|
|
class_view/
|
|
code_summary/
|
|
todo_cli/
|
|
main.py
|
|
storage.py
|
|
todo.py
|
|
```
|
|
|
|
## 🚀 Installation
|
|
|
|
```bash
|
|
git clone https://github.com/your-username/todo_cli.git
|
|
cd todo_cli
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
## 💻 Usage
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
python -m venv .venv
|
|
source .venv/bin/activate # Windows: .venv\Scripts\activate
|
|
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
Run from the project root:
|
|
|
|
```bash
|
|
python -m todo_cli --help
|
|
```
|
|
|
|
## Usage Example
|
|
|
|
```bash
|
|
python -m todo_cli add "Write README"
|
|
python -m todo_cli list
|
|
```
|
|
|
|
Example output:
|
|
|
|
```text
|
|
1. [ ] Write README
|
|
```
|
|
|
|
Mark a task as done:
|
|
|
|
```bash
|
|
python -m todo_cli done 1
|
|
```
|
|
|
|
Remove a task:
|
|
|
|
```bash
|
|
python -m todo_cli delete 1
|
|
```
|
|
|
|
## 📄 License
|
|
|
|
MIT License
|