Skip to content

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

docs(video-lesson): clarify runtime prerequisites

Bingxi Zhao (Frank)9410ef3ca22c
diff --git a/README.md b/README.md
index bc3afbb61..4c1fb35a9 100644
--- a/README.md
+++ b/README.md
@@ -391,13 +391,13 @@ pip install -e ".[math-animator]" # Manim addon; requires LaTeX/ffmpeg/system
pip install -e ".[edge-tts]" # Optional free speech provider and video-lesson narration
```
+**Video Lesson:** choose Video Lesson in chat or run `deeptutor run video_lesson "Explain a concept"`. The backend needs Node.js 22+, npm, and access to a running Docker daemon using Linux containers. First use downloads pinned Remotion packages and a Node container image. Frame checks run without network access, host mounts, or host credentials, and stop when the turn is cancelled; there is no unsandboxed fallback. The resulting lesson plays in the browser, with captions when optional narration is unavailable.
+
</details>
<details>
<summary><b>Frontend dependency tweaks & dev-server troubleshooting</b></summary>
-**Video Lesson:** choose Video Lesson in chat or run `deeptutor run video_lesson "Explain a concept"`. The backend needs Node.js 22+, npm, and access to a running Docker daemon using Linux containers. First use downloads pinned Remotion packages and a Node container image. Frame checks run without network access, host mounts, or host credentials, and stop when the turn is cancelled; there is no unsandboxed fallback. The resulting lesson plays in the browser, with captions when optional narration is unavailable.
-
**Changing frontend dependencies:** run `npm install --legacy-peer-deps` to refresh `web/package-lock.json`, then commit both `web/package.json` and `web/package-lock.json`.
**Stuck dev server:** if `deeptutor start --dev` reports an existing frontend that isn't responding, stop the PID it prints. If no Next.js process is actually running, the lock files are stale — remove them and retry:
diff --git a/tests/agents/video_lesson/test_runtime.py b/tests/agents/video_lesson/test_runtime.py
index f87c79779..ae672c492 100644
--- a/tests/agents/video_lesson/test_runtime.py
+++ b/tests/agents/video_lesson/test_runtime.py
@@ -41,6 +41,7 @@ def test_prepare_workdir_writes_the_voice_module(tmp_path: Path) -> None:
def test_video_lesson_requires_a_docker_runtime(monkeypatch) -> None:
import pytest
+
from deeptutor.agents.video_lesson import runtime
monkeypatch.setattr(runtime.shutil, "which", lambda _name: None)