# ReviewPlanner **Repository Path**: scpcddk/review-planner ## Basic Information - **Project Name**: ReviewPlanner - **Description**: 个人智能复习计划助手:根据学习内容生成复习任务,结合 AI 测试与掌握情况安排复习 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: codex/project-setup - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-11-05 - **Last Updated**: 2026-11-10 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 个人智能复习计划助手 帮助用户根据实际学过的内容,知道什么时候复习什么。 当前阶段:v1.2.0(阶段一至五完成,A01–A17 全部达成;界面按个人笔记风格改版,新增笔记页内嵌笔记站)。 ## 已确认的使用流程 1. 用户粘贴今天实际学过的原文,允许只是一小块内容。 2. AI 整理复习主题和自测问题,用户简单确认或调整。 3. 确认加入后,当天可以做一道摸底题。未测时默认次日到期,测过则将结果用于后续排期。 4. 列出全部到期内容,显示优先级、原因和预计耗时,由用户选择复习多少。 5. 先简要显示知识点,让用户自行回忆,再由 AI 默认测试一道题。 6. 判分后先给出参考答案,用户可结束本轮或选择"还没掌握,继续问";答错后再出一道题,连续答错两次则转去回看笔记。 7. 保存测试和回看情况,作为下一次复习安排的依据。 第一版只在用户自己的电脑上运行,本地保存数据,支持备份与恢复。 ## 项目文档 - [产品需求](docs/产品需求.md)汇总用户场景、产品规则、当前问题、验收标准和需求演变。 - [方案设计](docs/方案设计.md)收录技术选型、录入与复习流程、排期、DeepSeek API、阶段计划和评审修订。 - [开发记录](docs/开发记录.md)保留各阶段操作、问题复现、判断、修改、验证和 TRAE 交接。 - [验收记录](docs/验收记录.md)按 A01–A17 查找回归结果和对应证据。 - [课程作业要求](docs/课程作业要求.md)汇总交付、Word 报告和评分要求。截图编号和归档路径见[证据索引](docs/evidence/README.md)。 需要对照 [TRAE 初版方案](docs/归档/00_TRAE初版方案_完整整合.md)或视觉素材提示词时,可查阅[归档目录](docs/归档/)。 后续以 TRAE 为主要 AI 辅助开发工具,实际使用 DeepSeek API,并如实记录其他辅助工具的用途。作业要求提交 Gitee 源码仓库和 Word 报告。 ## 运行说明 环境:Windows + Python 3.13(已在 3.13.13 验证)。 ```powershell # 首次安装 python -m venv .venv .venv\Scripts\activate pip install -r requirements.txt # 配置密钥(二选一,阶段一不配置也可运行 Mock) $env:DEEPSEEK_API_KEY="sk-..." copy config.example.json config.json # 然后填写 api_key # 写入演示数据(可重复执行,不会产生重复记录) python scripts/seed_demo.py # 启动 streamlit run app.py ``` 浏览器打开 `http://localhost:8501`。 数据保存在 `data/review_planner.db`,首次启动自动建表,已被 Git 忽略。`config.json` 同样不入库,仓库只保留 `config.example.json`。 **当前可用**:四页界面(今日复习、录入、笔记、管理)、四表建库、DeepSeek 整理候选(无密钥回退 Mock)、知识点分类(与个人笔记一级板块一致)、笔记页内嵌笔记站(板块切换,可新标签打开)、确认入库与去重、排期与到期优先级、预计耗时、真实出题与四档判分、参考答案与缺失要点、主动继续问、主动查看笔记、连续答错回看、改判、摸底闭环、暂停与激活、删除与合并(合并前校验相似度)、备份导出与恢复(校验 + 自动回滚)。 验收结果见 [docs/验收记录.md](docs/验收记录.md):A01–A17 全部达成。 ## 备份与恢复 在「管理 → 备份与恢复」中操作: - **导出备份**:生成 `data/backups/review_planner_日期_时间.db`,可直接下载。 - **恢复备份**:上传 `.db` 文件后先检查 SQLite 完整性和必需表是否存在;通过并勾选确认才会覆盖当前数据。 - 恢复前会自动把当前数据库另存为 `review_planner_rollback_日期_时间.db`;写入后再次校验,失败则自动回滚。 - 损坏文件、空文件或缺少四张表的文件会被拒绝,当前数据不受影响。关键字段校验的缺口见[补充验收 B03](docs/产品需求.md#7-当前复查与补充验收)。 ## 自检脚本 ```powershell python scripts/check_schedule.py # 11 个排期场景 + 4 项优先级,纯计算、不碰数据库 python scripts/check_merge.py # 12 项合并、摸底与录入回归,每次运行使用独立临时目录,不碰正式数据 python scripts/check_review.py # 19 项复习状态机与界面流程回归,同样使用独立临时目录 python scripts/check_backup.py # 8 项备份与恢复回归,使用独立临时目录 ``` 四个脚本都返回退出码 0/1,末行输出"结果:全部通过"或失败项数,可直接用于提交前检查。