chen-todo 0.1.0__py3-none-any.whl

chen_todo-0.1.0.dist-info/METADATA

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: chen-todo
+Version: 0.1.0
+Summary: 一个简单友好的命令行待办清单工具
+Author: chen
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,productivity,task,todo,待办
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# todo-cli
+
+一个简单友好的命令行待办清单工具。用一条命令管理你的待办事项，数据保存在本地，随时可用。
+
+## ✨ 功能
+
+- ➕ 添加任务
+- 📋 查看任务（编号连续，删除后自动重排）
+- ✅ 标记完成
+- 🗑️ 删除任务
+- 🧹 一键清除所有已完成
+- 数据存在本地 JSON，中文友好，无需联网
+
+## 📦 安装
+
+```bash
+pip install todo-cli
+```
+
+## 🚀 使用
+
+```bash
+todo add 学会发布到PyPI
+todo add 买 一盒 牛奶
+todo list
+todo done 1
+todo remove 2
+todo clear
+todo --version
+todo --help
+```
+
+`todo list` 的输出长这样：
+
+```
+[✓]  1  买牛奶
+[ ]  2  学会发布到PyPI
+
+共 2 个任务，1 个已完成
+```
+
+## 💾 数据存在哪？
+
+所有任务保存在你用户主目录下的 `.todo/tasks.json`：
+
+- Windows：`C:\Users\你的用户名\.todo\tasks.json`
+- macOS / Linux：`~/.todo/tasks.json`
+
+## 🛠️ 参与开发
+
+```bash
+git clone <你的仓库地址>
+cd todo-cli
+uv sync
+uv run pytest
+uv run todo list
+```
+
+## 📄 License
+
+[MIT](LICENSE)

chen_todo-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+todo_cli/__init__.py,sha256=Y6Yh7JoMJ8EVqM_dcfJlXe6UjHH81M28zy0AXOwruMU,97
+todo_cli/cli.py,sha256=yBh-F-UfJq9Tjr_lFIl8UlvLtY5K7xyJ9GaLs5xq1o4,3747
+todo_cli/core.py,sha256=HrPpR9R3YlaQzB8diAAGXZ4BUi-rREXRQ0ZBhR9SffM,2694
+todo_cli/storage.py,sha256=llgSKon65SuFYE2UtHerUWj3iLOM4leRaNg8fxWxiS8,1663
+chen_todo-0.1.0.dist-info/METADATA,sha256=syDN-1TT6z3WtgpyA6HlbjdOocHyrEEWBv7K1-jowLc,1495
+chen_todo-0.1.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+chen_todo-0.1.0.dist-info/entry_points.txt,sha256=tbLFspxat4zitLAWOPfWh7DJ_QgTNeKxfwkPKFSPb8s,43
+chen_todo-0.1.0.dist-info/licenses/LICENSE,sha256=LGV1Ciet_f6yEbN2QVwQIgwpYVGlz7XsNGGh0Uc_A9Q,1069
+chen_todo-0.1.0.dist-info/RECORD,,

chen_todo-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

chen_todo-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+todo = todo_cli.cli:main

chen_todo-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 你的名字
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

todo_cli/__init__.py

@@ -0,0 +1,3 @@
+"""todo_cli —— 一个简单友好的命令行待办清单工具。"""
+
+__version__ = "0.1.0"

todo_cli/cli.py

@@ -0,0 +1,124 @@
+"""命令行界面：把「存取」(storage) 和「逻辑」(core) 拼起来，
+并用 argparse 解析 add / list / done / remove / clear 等子命令。
+
+pyproject.toml 里配的 todo 命令，最终执行的就是这里的 main()。
+"""
+
+import argparse
+import sys
+
+from todo_cli import __version__, core, storage
+
+
+# ---- storage 和 core 之间的「翻译」：dict ↔ Task ----
+
+def _load():
+    return [core.Task.from_dict(d) for d in storage.load_tasks()]
+
+
+def _save(tasks):
+    storage.save_tasks([task.to_dict() for task in tasks])
+
+
+# ---- 每个子命令对应一个处理函数 ----
+
+def cmd_add(args):
+    title = " ".join(args.title)
+    tasks = _load()
+    task = core.add_task(tasks, title)
+    _save(tasks)
+    print(f"已添加 #{len(tasks)}：{task.title}")      # 新任务在末尾，编号 = 当前总数
+
+
+def cmd_list(args):
+    tasks = _load()
+    if not tasks:
+        print('还没有任务。用  todo add "买牛奶"  添加一个吧！')
+        return
+    width = len(str(len(tasks)))                        # 最大编号有几位数，用来对齐
+    done_count = 0
+    for number, task in enumerate(tasks, start=1):      # 编号 = 位置，永远连续
+        box = "✓" if task.done else " "
+        if task.done:
+            done_count += 1
+        print(f"[{box}]  {number:>{width}}  {task.title}")
+    print()
+    print(f"共 {len(tasks)} 个任务，{done_count} 个已完成")
+
+
+def cmd_done(args):
+    tasks = _load()
+    try:
+        task = core.mark_done(tasks, args.number)
+    except core.TaskNotFoundError as error:
+        print(error, file=sys.stderr)
+        sys.exit(1)
+    _save(tasks)
+    print(f"已完成 #{args.number}：{task.title}")
+
+
+def cmd_remove(args):
+    tasks = _load()
+    try:
+        task = core.remove_task(tasks, args.number)
+    except core.TaskNotFoundError as error:
+        print(error, file=sys.stderr)
+        sys.exit(1)
+    _save(tasks)
+    print(f"已删除：{task.title}")                       # 删除后编号会重排，这里就不提编号了
+
+
+def cmd_clear(args):
+    tasks = _load()
+    count = core.clear_done(tasks)
+    _save(tasks)
+    print(f"已清除 {count} 个已完成的任务")
+
+
+# ---- 组装命令行解析器 ----
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="todo",
+        description="一个简单友好的命令行待办清单工具。",
+    )
+    parser.add_argument(
+        "--version", action="version", version=f"%(prog)s {__version__}"
+    )
+    subparsers = parser.add_subparsers(dest="command")
+
+    # todo add 买牛奶
+    p_add = subparsers.add_parser("add", help="添加一个新任务")
+    p_add.add_argument("title", nargs="+", help="任务内容（可以不加引号）")
+    p_add.set_defaults(func=cmd_add)
+
+    # todo list
+    p_list = subparsers.add_parser("list", help="列出所有任务")
+    p_list.set_defaults(func=cmd_list)
+
+    # todo done 1
+    p_done = subparsers.add_parser("done", help="把某个任务标记为已完成")
+    p_done.add_argument("number", type=int, help="任务编号（就是 list 里显示的数字）")
+    p_done.set_defaults(func=cmd_done)
+
+    # todo remove 1
+    p_remove = subparsers.add_parser("remove", help="删除某个任务")
+    p_remove.add_argument("number", type=int, help="任务编号（就是 list 里显示的数字）")
+    p_remove.set_defaults(func=cmd_remove)
+
+    # todo clear
+    p_clear = subparsers.add_parser("clear", help="清除所有已完成的任务")
+    p_clear.set_defaults(func=cmd_clear)
+
+    args = parser.parse_args()
+
+    # 用户只敲了 todo、没给子命令 → 打印帮助
+    if not hasattr(args, "func"):
+        parser.print_help()
+        return
+
+    args.func(args)
+
+
+if __name__ == "__main__":
+    main()

todo_cli/core.py

@@ -0,0 +1,83 @@
+"""核心逻辑层：定义「任务」的结构，以及增、删、改、查的纯逻辑。
+
+这一层只跟「内存里的任务列表」打交道，不碰文件、也不管命令行。
+
+关于「编号」：我们不给任务存固定的 id，而是用它在清单里的「位置」当编号
+（第 1 个就是 1、第 2 个就是 2……）。这样一删任务，后面的自动往前补位，
+编号永远是连续的 1、2、3——和 ufw 等工具的行为一致。
+"""
+
+from dataclasses import dataclass
+from datetime import datetime
+
+
+class TaskNotFoundError(Exception):
+    """给的编号在当前清单里不存在（越界）时抛出。"""
+
+    def __init__(self, number):
+        self.number = number
+        super().__init__(f"找不到编号为 {number} 的任务")
+
+
+@dataclass
+class Task:
+    """一个待办任务。注意：没有 id 字段，编号靠「位置」决定。"""
+
+    title: str
+    done: bool = False
+    created_at: str = ""
+
+    @classmethod
+    def from_dict(cls, data):
+        # 用 .get() 给默认值：老数据即使还带着多余的 "id" 字段也照样能读，
+        # 缺 created_at 也不会崩。
+        return cls(
+            title=data["title"],
+            done=data.get("done", False),
+            created_at=data.get("created_at", ""),
+        )
+
+    def to_dict(self):
+        return {
+            "title": self.title,
+            "done": self.done,
+            "created_at": self.created_at,
+        }
+
+
+def _task_at(tasks, number):
+    """按「从 1 开始的编号」取任务；越界就抛 TaskNotFoundError。"""
+    if number < 1 or number > len(tasks):
+        raise TaskNotFoundError(number)
+    return tasks[number - 1]
+
+
+def add_task(tasks, title):
+    """新建一个任务，追加到清单末尾，并返回它。"""
+    task = Task(
+        title=title,
+        done=False,
+        created_at=datetime.now().isoformat(timespec="seconds"),
+    )
+    tasks.append(task)
+    return task
+
+
+def mark_done(tasks, number):
+    """把第 number 个任务标记为已完成，返回它；编号非法就抛异常。"""
+    task = _task_at(tasks, number)
+    task.done = True
+    return task
+
+
+def remove_task(tasks, number):
+    """删除第 number 个任务，返回被删掉的那个；编号非法就抛异常。"""
+    _task_at(tasks, number)              # 先校验编号（越界会抛异常）
+    return tasks.pop(number - 1)         # 按位置删除，后面的自动补位
+
+
+def clear_done(tasks):
+    """删除所有已完成的任务，返回删掉的数量。"""
+    before = len(tasks)
+    tasks[:] = [task for task in tasks if not task.done]   # 原地只保留未完成的
+    return before - len(tasks)

todo_cli/storage.py

@@ -0,0 +1,41 @@
+"""数据存储层：负责把任务列表读写到本地 JSON 文件。
+
+这一层只关心「数据怎么存到硬盘、怎么读回来」，
+完全不关心任务的业务逻辑（增删改查是 core.py 的事）。
+把「存储」和「逻辑」分开的好处：将来想换存储方式
+（比如换成数据库），只改这一个文件就行，别处都不用动。
+"""
+
+import json
+from pathlib import Path
+
+# 数据文件放在「用户主目录」下的 .todo 文件夹里。
+# Path.home() 在你的电脑上是 C:\Users\chen，
+# 所以数据文件就是  C:\Users\chen\.todo\tasks.json
+DATA_DIR = Path.home() / ".todo"
+DATA_FILE = DATA_DIR / "tasks.json"
+
+
+def load_tasks(path=DATA_FILE):
+    """读出所有任务，返回一个列表（里面每一项是一个 dict）。
+
+    - 文件还不存在（第一次用）        → 返回空列表 []
+    - 文件是空的、或内容坏了          → 也返回空列表，保证程序不会崩
+    """
+    if not path.exists():
+        return []
+    try:
+        text = path.read_text(encoding="utf-8")
+        return json.loads(text)
+    except (json.JSONDecodeError, ValueError):
+        return []
+
+
+def save_tasks(tasks, path=DATA_FILE):
+    """把任务列表写回文件。"""
+    # 确保 .todo 文件夹存在，不存在就自动创建（parents=True 连父目录一起建）
+    path.parent.mkdir(parents=True, exist_ok=True)
+    # ensure_ascii=False → 中文原样保存，不会变成 买 这种乱码
+    # indent=2           → 存成带缩进的漂亮格式，方便打开来看
+    text = json.dumps(tasks, ensure_ascii=False, indent=2)
+    path.write_text(text, encoding="utf-8")