AI导哈

课程计划生成工具

NCERT Lesson Plan Generator (KVS) 是一个轻量级的网页应用和MCP支持的工具，用于通过语音或文本输入生成NCERT风格的课程计划。

  • by ChetanIshant
  • Python
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 ChetanIshant/Voice-Lesson-Planner-Agent

使用说明

NCERT课程计划生成器（KVS）

轻量级的web应用程序和支持MCP的工具，可以使用语音或文本输入生成NCERT风格的课程计划。

主要特点

  • 用于创建课程的语音和文本输入
  • 生成多会话课程计划、工作表和资源
  • 导出为DOCX和PDF
  • 本地SQLite数据库（默认），用于存储成绩单和课程
  • MCP集成和用于编程访问的FastAPI路由器

先决条件

  • Python 3.10+
  • 点
  • （可选）Groq API键，用于高质量STT/LLM功能

安装依赖项

pip install -r requirements.txt

环境

  • 创建一个 .env 在项目根目录下的文件中设置环境变量（可选）：
GROQ_API_KEY=your_groq_api_key_here
GROQ_MODEL=llama-3.3-70b-versatile

注意：默认情况下，该项目使用本地SQLite数据库文件(kvs_lessonplan.db).无需外部数据库即可在本地运行。

初始化数据库 %-该应用程序在启动时会自动创建SQLite数据库，但您可以使用以下方式查看统计数据或重置：

# Show stats
python setup_database.py --info

# Reset database (destructive)
python setup_database.py --reset

运行应用程序（开发）

# Use uvicorn to serve the ASGI app (Socket.IO + FastAPI)
uvicorn main:socket_app --reload --host 0.0.0.0 --port 5000

在以下位置打开UI：http://localhost:5000

MCP和API

  • MCP工具的FastAPI路由器安装在 /mcp （参见 mcp_integration.py).
  • 中有一个可选的MCP服务器实现 mcp_server.py 其可以单独运行。

重要文件

  • main.py --应用程序入口点，Socket。IO和路由处理程序
  • templates/index_final.html --应用程序使用的前端UI
  • database.py --SQLAlchemy模型和数据库设置（默认为SQLite）
  • crud.py --数据库CRUD帮助程序
  • mcp_integration.py --FastAPI MCP路由器和助手功能
  • mcp_server.py --独立MCP服务器（基于stdio）
  • setup_database.py --用于检查/重置数据库的辅助脚本

如何使用（快速）

  • 使用UI在语音/文本模式之间切换，提供主题/科目/课程，然后生成教案。
  • 从用户界面下载生成的DOCX或PDF格式的课程计划。

开发人员说明

  • 默认数据库是SQLite，便于本地开发。如果你想要PostgreSQL，更新 database.py 读 DATABASE_URL 从 .env 并相应地创建引擎。
  • Groq集成需要有效的 GROQ_API_KEY 使用Groq STT/LLM功能。

有用的命令

# Run the app
uvicorn main:socket_app --reload --port 5000

# Inspect DB (local SQLite)
sqlite3 kvs_lessonplan.db ".tables"

# Run MCP server (stdio)
python mcp_server.py

端口注意事项

  • 文档中使用的默认端口： 5000.启动时根据需要进行调整 uvicorn.

贡献

  • 分叉，创建一个特征分支，并打开一个pull请求。

许可证

  • 麻省理工学院

联系

  • 在存储库中为问题或错误创建一个问题。

  • MCP协议

快乐教学！ 🎉

相关 MCP