lecture-forge 0.4.1

AI-powered lecture material generator with multilingual support using LangChain

LectureForge 🎓

AI-Powered Lecture Material Generator using Multi-Agent Pipeline System

🚀 v0.4.1 | translate 명령어 품질 개선 🌐 + --with-diagrams 옵션 🎛️ + 코드 품질 향상 🔧

PDF, 웹페이지, 인터넷 검색에서 정보를 수집하여 고품질 강의자료를 자동 생성하는 AI 시스템입니다.

핵심 통계: 10개 에이전트 | 9개 도구 | 8개 CLI 명령 | 1,356+ 테스트 (~48% 커버리지) | ~$0.035/60분 강의 | Python 3.11 권장

데이터 위치: ~/Documents/LectureForge/ (일반 폴더, Finder/탐색기에서 바로 접근)

---

📋 목차

• 주요 기능
• 빠른 시작
• 사용법
• 명령어 가이드
• FAQ
• 변경 이력
• 기여하기

---

✨ 주요 기능

컨텐츠 생성

• 📚 멀티소스 수집: PDF, URL, 웹 검색을 통한 포괄적 정보 수집
• 📍 Location-based 이미지 매칭: RAG 컨텍스트 기반 자동 이미지 배치 (+750% 활용률)
• 🖼️ 대화형 이미지 편집: 생성된 강의의 이미지 삭제/교체 (Vector DB 기반 대안 검색)
• 🎨 구조화된 HTML 출력: Mermaid 다이어그램, 검색 인덱스, 코드 하이라이팅
• 🎬 프레젠테이션 슬라이드: Reveal.js 기반 자동 변환 (v0.3.0 대폭 개선)

품질 보증

• ✅ 6차원 품질 평가: 완성도, 흐름, 시간, 난이도, 시각자료, 정확성
• 🔄 자동 개선: 품질 기준 미달 시 최대 3회 자동 수정
• 🧠 RMC 자기검토 (v0.3.8+): 에이전트 내부 2단계 자기반성 (Layer 1 검토 + Layer 2 검토의 검토)
  • CurriculumDesigner: 섹션 순서 논리성, 학습목표 커버리지, 선수 내용 순서 자동 검증 및 수정
  • ContentWriter: 개념 비약, 설명 모호성, 흐름 단절 등 의미론적 품질 검토 후 수정
  • QAAgent: 각 주장을 소스 컨텍스트와 대조 → 할루시네이션 항목 제거 또는 경고 표시
• 🧪 테스트 커버리지: 1,356+ 테스트 함수 (81개 파일, ~48% 커버리지)

지식 관리

• 🗄️ RAG 기반 지식창고: ChromaDB 벡터 DB로 대화형 Q&A 지원
• 🌐 다국어 지원: 한영 혼합 PDF 지원, 자동 언어 감지, Cross-lingual 검색 (v0.3.2+)
• 🎯 고급 RAG 품질 (v0.3.5+):
  • 400단어 구조화 답변 (5개 Markdown 섹션 강제)
  • 15+15 듀얼 쿼리 검색 (다국어, top-12 결과)
  • Rich Markdown 패널 렌더링 (터미널에서 아름다운 출력)
  • 동적 신뢰도 점수 (ChromaDB L2 거리 올바른 변환)
• ⚡ 쿼리 캐싱: 동일 질문 60% 빠른 응답
• 💬 소스 인용: 자동 참조 및 페이지 번호 제공

안정성 & 성능

• 🔄 자동 재시도: API 실패 시 지수 백오프 (최대 3회)
• 💰 비용 추적: 실시간 토큰 사용량 및 비용 추정
• 🔧 타입 힌트: 71% 타입 안정성
• 🎯 예외 처리: 구조화된 예외 시스템 (9개 카테고리)
• 📝 프롬프트 관리: 템플릿 기반 프롬프트 시스템

---

🚀 최근 개선사항 (v0.4.1)

translate 명령어 품질 대폭 개선 + --with-diagrams 옵션:

• translate 명령어 (영문 PDF → 한국어 강의자료):
  • PDF 아티팩트 제거: 단독 페이지 번호·도메인 워터마크·짧은 단편 줄 자동 제거
  • TOC 감지·필터: 차례 페이지 자동 감지 및 제외 (점선+숫자 패턴 >40%)
  • 빈 섹션 제거: 30 단어 미만 섹션 자동 제외
  • AI/ML 용어 사전 (_TERM_GLOSSARY): 25개 표준 용어 일관 번역
  • 할루시네이션 가드: 번역 청크에 ⛔ 절대 금지 규칙 추가
  • 이미지 중복 제거: 크로스 섹션 globally_used_ids 집합으로 중복 이미지 방지
• --with-diagrams 플래그: Mermaid 다이어그램 생성 opt-in (기본 OFF, PDF 이미지 우선)
• 콘텐츠 메타 주석 제거: "이제 X단어를 달성하였습니다" 등 AI 메타 주석 자동 삭제
• 코드 품질: constants.py 상수 모듈, 예외 처리 세분화, 타입 힌트 보완

전체 변경 이력은 아래 변경 이력 참조

---

🚀 빠른 시작

1️⃣ 설치

방법 1: pipx로 설치 (가장 간편 ⭐⭐)

# pipx 설치 (아직 없는 경우)
pip install pipx
pipx ensurepath

# lecture-forge 설치 (격리된 환경에서 자동 설치)
pipx install lecture-forge

# playwright 설치 (pipx 환경에 추가)
pipx inject lecture-forge playwright
pipx runpip lecture-forge install playwright
playwright install chromium

# 사용
lecture-forge create

pipx의 장점:

• ✅ 격리된 환경에서 자동 설치
• ✅ 시스템 전역에서 lecture-forge 명령 사용 가능
• ✅ 다른 Python 프로젝트와 의존성 충돌 없음
• ✅ conda/venv 환경 관리 불필요

방법 2: PyPI + conda 환경 (권장 ⭐)

# Python 3.11 환경 생성 (강력 권장)
conda create -n lecture-forge python=3.11
conda activate lecture-forge

# PyPI에서 설치
pip install lecture-forge

# 웹 스크래핑용 브라우저 설치
playwright install chromium

방법 3: 개발 설치 (소스 코드 수정 시)

# Git 클론
git clone https://github.com/bullpeng72/Lecture_forge.git
cd Lecture_forge

# Python 3.11 환경 생성
conda create -n lecture-forge python=3.11
conda activate lecture-forge

# 로컬 소스에서 설치
pip install -e .

# 웹 스크래핑용 브라우저 설치
playwright install chromium

Python 버전 호환성:

• ✅ Python 3.11: 강력 권장 - 모든 의존성 완벽 지원
• ✅ Python 3.12: 완벽 지원 - v0.3.3부터 공식 지원
• ✅ Python 3.13: 지원됨 - v0.3.8부터 검증 완료

Python 3.11, 3.12, 3.13 모두 지원합니다.

2️⃣ 환경 설정

방법 1: 대화형 설정 (권장 ⭐)

# 대화형 설정 마법사 실행
lecture-forge init

이 명령어는 다음을 수행합니다:

• ✅ 플랫폼별 최적 위치에 .env 파일 자동 생성
  • Windows: %USERPROFILE%\Documents\LectureForge\.env
  • Mac/Linux: ~/Documents/LectureForge/.env
• ✅ 필수 API 키 입력 안내 (OpenAI, Serper)
• ✅ 선택적 이미지 검색 API 설정 (Pexels, Unsplash)
• ✅ 파일 권한 자동 설정 (Unix/Mac: 600)

방법 2: 수동 설정

# .env 파일 생성 (프로젝트 개발 시)
cp .env.example .env

.env 파일을 열어 다음 항목을 설정하세요:

필수 API 키:

# OpenAI API (필수)
OPENAI_API_KEY=sk-proj-...

# 검색 API (필수)
SERPER_API_KEY=...                # 무료: 2,500회/월

선택 사항:

# 이미지 검색 API (선택)
PEXELS_API_KEY=...                # 무료 무제한
UNSPLASH_ACCESS_KEY=...           # 무료: 50회/시간

# 검색 및 크롤링 설정 (기본값으로 충분)
SEARCH_NUM_RESULTS=10             # 검색 결과 수 (최대 100)
DEEP_CRAWLER_MAX_PAGES=10         # 크롤링 페이지 수
IMAGE_SEARCH_PER_PAGE=10          # 이미지 검색 결과 수

# 품질 설정
QUALITY_THRESHOLD=80              # 품질 임계값 (70-90)
MAX_ITERATIONS=3                  # 최대 개선 반복 횟수

💡 더 많은 설정 옵션은 .env.example 파일 참조

.env 파일 위치

LectureForge는 다음 순서로 .env 파일을 탐색합니다:

1. 환경 변수: LECTURE_FORGE_ENV_FILE로 지정한 경로
2. 현재 디렉토리: ./.env
3. 사용자 디렉토리 (권장):
   • Windows: %USERPROFILE%\Documents\LectureForge\.env
   • Mac/Linux: ~/Documents/LectureForge/.env

API 키 획득:

• OpenAI: platform.openai.com (사용량 기반 과금)
• Serper: serper.dev (무료 2,500회/월)
• Pexels: pexels.com/api (무료)
• Unsplash: unsplash.com/developers (무료 50회/시간)

3️⃣ 첫 강의 생성

lecture-forge create

대화형으로 강의 정보를 입력하면 자동으로 강의자료가 생성됩니다! 🎉

---

💻 사용법

명령어 개요

명령어	설명	주요 옵션
init	초기 설정	--path
create	강의 생성	--image-search, --quality-level
translate	영문 PDF → 한국어 강의자료 (v0.4.1+)	--no-translate, --with-diagrams, --audience-level
chat	Q&A 모드	--knowledge-base
edit-images	이미지 편집	--output
improve	강의 향상 / 재평가	--to-slides, --re-evaluate
cleanup	지식베이스 관리	--all
home	폴더 열기 (v0.3.1+)	outputs, data, kb, env

빠른 실행 예제

# 🚀 초기 설정 (처음 한 번만)
lecture-forge init

# 🎓 강의 생성 (대화형 - 가장 간단)
lecture-forge create

# 🎓 고품질 강의 (이미지 검색 포함)
lecture-forge create --image-search --quality-level strict

# 💬 Q&A 모드 (자동으로 최신 지식베이스 선택)
lecture-forge chat

# 🌐 영문 PDF 번역 (한국어 강의자료 생성)
lecture-forge translate paper.pdf
lecture-forge translate paper.pdf --no-translate   # 원문 구조 확인 (번역 없음)

# 🎨 슬라이드 변환
lecture-forge improve outputs/lecture.html --to-slides

# 🖼️ 이미지 편집
lecture-forge edit-images outputs/lecture.html

# 🧹 지식베이스 정리 (대화형 선택)
lecture-forge cleanup

# 📂 폴더 열기 (강의 결과물 확인)
lecture-forge home outputs

명령어 상세 가이드

🚀 init - 초기 설정

기본 사용:

lecture-forge init

대화형 마법사가 API 키 입력을 안내하고 자동으로 .env 파일을 생성합니다.

옵션:

옵션	설명	사용 예
--path PATH	커스텀 디렉토리 지정	--path /custom/path

기본 저장 위치:

• Windows: C:\Users\<username>\Documents\LectureForge\.env
• Mac/Linux: ~/Documents/LectureForge/.env

예제:

# 기본 위치에 설정 (권장)
lecture-forge init

# 커스텀 디렉토리 사용
lecture-forge init --path /my/config/dir

# 현재 디렉토리에 생성
lecture-forge init --path .

하는 일:

1. 필수 API 키 입력 (OpenAI, Serper)
2. 선택적 이미지 API 설정 (Pexels, Unsplash)
3. .env 파일 자동 생성
4. 기본 설정 값 자동 설정
5. 파일 권한 보안 설정 (Unix/Mac)

---

📚 create - 강의 생성

기본 사용:

lecture-forge create

대화형으로 정보를 입력하면 자동으로 강의를 생성합니다.

옵션:

옵션	설명	사용 예
--config FILE	YAML 설정 파일 사용	--config lecture.yaml
--image-search	웹 이미지 검색 활성화 Pexels (기본 활성화)	--no-image-search
--quality-level LEVEL	품질 기준 설정	--quality-level strict
--output FILE	출력 파일명 지정 (확장자 제외)	--output my_lecture
--async-mode	Async I/O 사용 (70% 빠름, 실험적)	--async-mode
--include-pdf-images	PDF 이미지 추출 및 location-based 자동 배치 (기본 활성화)	--no-include-pdf-images
--auto-describe-images	PDF 이미지 GPT-4o-mini 설명 자동 생성 (기본 활성화)	--no-auto-describe-images
--existing-kb PATH	기존 지식베이스 재사용 또는 확장	--existing-kb data/vector_db/...
--kb-mode MODE	KB 사용 방식: reuse_only(읽기 전용, 기본값) / extend(확장)	--kb-mode extend

품질 레벨:

• lenient (70점): 빠른 초안
• balanced (80점): 기본값 ✅
• strict (90점): 고품질

예제:

# 기본 생성
lecture-forge create

# 고품질 + 이미지 검색
lecture-forge create --image-search --quality-level strict

# Async 모드 (70% 빠름, 실험적)
lecture-forge create --async-mode

# YAML 설정 사용
lecture-forge create --config my_config.yaml

---

💬 chat - Q&A 모드

기본 사용:

lecture-forge chat

자동으로 최신 지식베이스를 선택합니다.

옵션:

옵션	설명	사용 예
--knowledge-base PATH	특정 지식베이스 지정	-kb ./data/vector_db/AI_xxx

대화형 명령어:

• /help: 도움말 표시
• /exit, /quit: 종료
• Ctrl+C: 강제 종료

예제:

# 자동 선택
lecture-forge chat

# 특정 지식베이스 사용
lecture-forge chat -kb ./data/vector_db/lecture_20260209_123456

---

🖼️ edit-images - 이미지 편집

기본 사용:

lecture-forge edit-images outputs/lecture.html

옵션:

옵션	설명	사용 예
--output FILE	출력 파일 경로	-o outputs/edited.html

대화형 명령어:

명령어	설명	예시
d <번호>	이미지 삭제	d 3
u <번호>	삭제 취소	u 3
r <번호>	이미지 교체 (Vector DB 검색)	r 5
s	변경사항 저장	s
/exit, /quit (또는 q)	종료 (저장 안 함)	/exit
h	도움말	h

예제:

# 기본 (원본_edited.html로 저장)
lecture-forge edit-images outputs/my_lecture.html

# 출력 파일 지정
lecture-forge edit-images outputs/my_lecture.html -o outputs/final.html

---

🌐 translate - 영문 PDF → 한국어 강의자료 (v0.4.1+)

기본 사용:

lecture-forge translate paper.pdf

영어 PDF에서 챕터 구조를 추출하고, 한국어로 번역하여 HTML 강의자료를 생성합니다.

옵션:

옵션	설명	사용 예
--output FILE	출력 파일명 지정 (확장자 제외)	-o my_lecture_ko
--quality-level LEVEL	품질 기준: lenient(70) / balanced(80) / strict(90)	--quality-level strict
--audience-level LEVEL	대상 수준: beginner / intermediate / advanced	--audience-level beginner
--no-translate	번역 없이 원문 구조만 추출 (구조 디버깅용, 빠름)	--no-translate
--with-slides	슬라이드 변환도 함께 수행	--with-slides
--with-diagrams	Mermaid 다이어그램 자동 생성 (기본 OFF)	--with-diagrams

구조 추출 우선순위:

1. PDF TOC — 가장 정확, 학술 PDF 80%+ 적용
2. 폰트 크기 분석 — 본문보다 큰 폰트 자동 감지
3. 페이지 그룹 (폴백) — 균등 페이지 범위 분할

번역 특징:

• 기술 용어: 한국어(English) 형식 유지 (예: 신경망(Neural Network))
• 코드 블록: __CODE_BLOCK_N__ 플레이스홀더로 원문 보존
• AI/ML 표준 용어 사전 25개 적용 (일관된 번역)
• PDF 아티팩트 자동 제거 (페이지 번호, 워터마크 등)

예제:

# 기본 번역 (→ paper_ko.html)
lecture-forge translate paper.pdf

# 출력 파일명 지정
lecture-forge translate paper.pdf -o my_lecture_ko

# 원문 구조 확인 (번역 없음, 빠름)
lecture-forge translate paper.pdf --no-translate

# 고품질 + 슬라이드 변환
lecture-forge translate paper.pdf --quality-level strict --with-slides

# 초급 대상 번역
lecture-forge translate paper.pdf --audience-level beginner

# Mermaid 다이어그램 생성 포함 (기본 OFF)
lecture-forge translate paper.pdf --with-diagrams

---

🎨 improve - 강의 향상

기본 사용:

lecture-forge improve outputs/lecture.html --to-slides

옵션:

옵션	설명	사용 예
--to-slides	Reveal.js 슬라이드 변환 (*_slides.html) — 섹션별 LLM 재작성 기본 포함 (≤35자, 말줄임표 없음)	--to-slides
--with-notes	슬라이드별 발표자 노트 자동 생성 (LLM)	--with-notes
--re-evaluate	KB 기반 품질 재평가 + 미반영 내용 보충 추가 (*_enhanced.html)	--re-evaluate
--quality-level LEVEL	재평가 품질 기준: lenient(70) / balanced(80) / strict(90)	--quality-level strict
--kb PATH	KB 경로 수동 지정 (HTML 메타데이터 없는 기존 파일용 fallback)	--kb /path/to/vector_db/...

예제:

# 슬라이드 변환 (기본)
lecture-forge improve outputs/lecture.html --to-slides

# 발표자 노트 포함 (브라우저에서 S키)
lecture-forge improve outputs/lecture.html --to-slides --with-notes

# KB 기반 품질 재평가 + 보충 (→ *_enhanced.html)
lecture-forge improve outputs/lecture.html --re-evaluate

# 엄격한 기준으로 재평가
lecture-forge improve outputs/lecture.html --re-evaluate --quality-level strict

# 기존 파일 (메타데이터 없음) — KB 경로 수동 지정
lecture-forge improve outputs/lecture.html --re-evaluate --kb ~/Documents/LectureForge/data/vector_db/MyTopic_...

# 재평가 + 슬라이드 변환 동시 적용
lecture-forge improve outputs/lecture.html --re-evaluate --to-slides

---

🧹 cleanup - 지식베이스 관리

기본 사용:

lecture-forge cleanup

대화형으로 삭제할 지식베이스를 선택합니다.

옵션:

옵션	설명	사용 예
--all	모든 지식베이스 삭제 (⚠️ 주의!)	--all

예제:

# 대화형 선택 (안전)
lecture-forge cleanup

# 전체 삭제 (복구 불가능!)
lecture-forge cleanup --all

📤 출력 결과

강의 생성 완료 후 다음 파일들이 생성됩니다:

outputs/
├── [주제]_[날짜시간].html           # 📄 HTML 강의자료
└── [주제]_[날짜시간]_slides.html   # 🎬 슬라이드 (--to-slides 사용 시)

data/
└── vector_db/
    └── [주제]_[날짜시간]/           # 🗄️ 지식베이스 (Q&A용)
        ├── chroma.sqlite3
        └── ...

포함 내용:

• ✅ HTML 강의자료: 이미지, Mermaid 다이어그램, 코드 하이라이팅, 검색 인덱스
• ✅ 지식베이스: ChromaDB 벡터 DB (대화형 Q&A 지원)
• ✅ 통계 정보: 품질 점수, 토큰 사용량, 예상 비용
• ✅ 슬라이드: Reveal.js 프레젠테이션 (선택 사항)

🔧 고급 설정 (.env 파일)

더 많은 제어가 필요한 경우 .env 파일에서 다음 설정을 조정할 수 있습니다:

# 검색 및 크롤링
SEARCH_NUM_RESULTS=20              # 기본: 10, 최대: 100
DEEP_CRAWLER_MAX_PAGES=30          # 기본: 10
DEEP_CRAWLER_MAX_DEPTH=3           # 기본: 2

# 이미지
IMAGE_SEARCH_PER_PAGE=15           # 기본: 10
MAX_IMAGES_PER_SEARCH=20           # 기본: 10

# 품질
QUALITY_THRESHOLD=90               # 기본: 80 (70-90)
MAX_ITERATIONS=5                   # 기본: 3

# 성능
CHUNK_SIZE=800                     # 기본: 1000 (작을수록 정밀)
WEB_SCRAPER_TIMEOUT=60             # 기본: 30초

💡 전체 설정 목록: .env.example 파일 참조 (15+ 환경변수)

---

🖼️ 이미지 편집

생성된 강의의 이미지를 대화형으로 편집할 수 있습니다.

기능

• 이미지 삭제: 원하지 않는 이미지 제거
• 이미지 교체: Vector DB에서 대안 이미지 자동 검색 및 교체
• 미리보기: 변경 전 모든 이미지 상태 확인
• 안전한 저장: 원본 백업 후 새 파일 생성

사용법

# 이미지 편집 모드 시작
lecture-forge edit-images outputs/lecture.html

# 출력 파일 지정
lecture-forge edit-images outputs/lecture.html -o outputs/lecture_v2.html

대화형 명령어

명령어	설명	예시
d <번호>	이미지 삭제	d 3
u <번호>	삭제 취소	u 3
r <번호>	이미지 교체 (대안 검색)	r 5
s	변경사항 저장	s
/exit, /quit (또는 q)	종료	/exit
h	도움말	h

작동 방식

1. HTML 분석: 강의 파일의 모든 이미지 추출 및 메타데이터 수집
2. 대화형 편집: 테이블 형식으로 이미지 목록 표시 및 편집
3. 대안 검색: Vector DB를 활용한 관련 이미지 자동 제안 (RAG 기반)
4. 변경 적용: 삭제/교체 작업 일괄 적용 및 새 파일 생성

예제

📸 강의 이미지 편집 모드
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

HTML: my_lecture.html
총 이미지: 25개

┏━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┓
┃ 번호  ┃ 설명                               ┃ 섹션              ┃ 페이지   ┃ 상태      ┃
┡━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━┩
│  1   │ Neural network architecture       │ 1. Introduction  │  5     │ 유지      │
│  2   │ Backpropagation diagram           │ 2. Core Concepts │  12    │ 🗑️ 삭제   │
│  3   │ Training process flowchart        │ 2. Core Concepts │  15    │ 🔄 교체   │
└──────┴───────────────────────────────────┴──────────────────┴────────┴──────────┘

명령 입력: r 3
🔍 이미지 3 대안 검색 중...
✅ 5개 대안 이미지 발견
선택: 1
✅ 이미지 3 교체 예정

명령 입력: s
💾 변경사항 저장됨: outputs/my_lecture_edited.html

---

🏗️ 시스템 아키텍처

Multi-Agent 파이프라인 (10개 전문 에이전트)

flowchart TD
    CLI["🖥️ CLI Interface<br/>입력 수집, 진행 상황, Q&A 인터랙션"]
    Orchestrator["⚙️ Pipeline Orchestrator<br/>에이전트 조율 및 태스크 관리"]
    Phase12["📚 Phase 1-2<br/>Collection & Analysis"]
    KB["🗄️ Knowledge Base<br/>Vector DB + RAG Caching"]
    Phase34["✍️ Phase 3-4<br/>Generation & Quality QA"]
    Output["📤 Output<br/>HTML + Slides"]

    CLI --> Orchestrator
    Orchestrator --> Phase12
    Orchestrator --> KB
    Phase12 -->|저장| KB
    KB -->|RAG Query| Phase34
    Phase34 -->|RAG Query| KB
    Phase34 --> Output

    style CLI fill:#e1f5ff
    style Orchestrator fill:#fff4e1
    style Phase12 fill:#e8f5e9
    style KB fill:#f3e5f5
    style Phase34 fill:#fff9c4
    style Output fill:#ffebee

10개 전문 에이전트

#	에이전트	역할	파일
1	Content Collector 📚	텍스트 수집 및 벡터화	content_collector.py
2	Image Collector 🖼️	이미지 수집 및 Vision AI 분석	image_collector.py
3	Content Analyzer 🔍	내용 분석 및 토픽 클러스터	content_analyzer.py
4	Curriculum Designer 📋	강의 구조 설계	curriculum_designer.py
5	Content Writer ✍️	RAG 기반 컨텐츠 생성	content_writer.py
6	Diagram Generator 📊	Mermaid 다이어그램 생성	diagram_generator.py
7	Quality Evaluator ✅	6차원 품질 평가	quality_evaluator.py
8	Revision Agent 🔄	자동/반자동 수정	revision_agent.py
9	Q&A Agent 🤖	지식창고 기반 대화 (RAG 캐싱)	qa_agent.py
10	HTML Assembler 🎨	최종 HTML 생성	html_assembler.py

9개 도구 (Tools)

#	도구	역할	파일
1	PDF Parser 📄	PDF 텍스트 추출	pdf_parser.py
2	Image Extractor 🖼️	PDF/HTML 이미지 추출	image_extractor.py
3	Web Scraper 🌐	웹 페이지 스크래핑	web_scraper.py
4	Playwright Crawler 🎭	동적 웹 크롤링	playwright_crawler.py
5	Deep Web Crawler 🕷️	다층 웹 크롤링 (Hada.io)	deep_web_crawler.py
6	Search Tool 🔍	Serper 검색 API	search_tool.py
7	Image Search 🎨	Pexels/Unsplash 검색	image_search.py
8	PDF Image Describer 📝	GPT-4o Vision 이미지 설명	pdf_image_describer.py
9	Image Editor ✂️	대화형 이미지 편집	image_editor.py

품질 평가 시스템 (6차원)

%%{init: {'theme':'base', 'themeVariables': { 'pie1':'#e8f5e9', 'pie2':'#bbdefb', 'pie3':'#fff9c4', 'pie4':'#f8bbd0', 'pie5':'#ffccbc', 'pie6':'#d1c4e9'}}}%%
pie title 품질 평가 가중치 분포
    "내용 완성도 (학습 목표)" : 25
    "논리적 흐름 (연결성)" : 20
    "난이도 적합성 (레벨)" : 20
    "시각자료 품질 (이미지)" : 15
    "시간 적합성 (분량)" : 10
    "기술적 정확성 (검증)" : 10

차원	가중치	평가 기준	세부 항목
📝 내용 완성도	25%	학습 목표 달성도	주제 커버리지, 깊이, 예제
🔗 논리적 흐름	20%	섹션 간 연결성	구조, 전개, 응집성
🎯 난이도 적합성	20%	수강생 레벨 일치	용어, 복잡도, 사전 지식
🖼️ 시각자료 품질	15%	이미지/다이어그램 충분성	관련성, 품질, 배치
⏱️ 시간 적합성	10%	강의 시간 vs 분량	단어 수, 밀도, 페이싱
✅ 기술적 정확성	10%	사실 관계 검증	코드, 개념, 용어

합격 기준: 80점 이상 (자동 반복 개선, 최대 3회)

---

❓ FAQ

설치 및 설정

Q: 어떤 Python 버전이 필요한가요?

A: Python 3.11, 3.12, 3.13 모두 지원합니다.

• ✅ Python 3.11: 완벽 지원 (권장)
• ✅ Python 3.12: 완벽 지원 (v0.3.3+)
• ✅ Python 3.13: 지원됨 (v0.3.8+, 검증 완료)

# 버전 확인
python --version

# Python 3.11 환경 생성 (권장)
conda create -n lecture-forge python=3.11
conda activate lecture-forge
pip install lecture-forge

Q: API 키가 꼭 필요한가요?

A:

• 필수: OpenAI API, Serper API
• 선택: Pexels API, Unsplash API (이미지 검색용)

이미지 API 없이도 PDF/웹 이미지만으로 작동합니다.

Q: 비용이 얼마나 드나요?

A: 실제 측정 비용 (v0.2.4+ 기준):

• 60분 강의: 약 $0.035
• 180분 강의: 약 $0.105

(GPT-4o-mini 사용. 보수적 이론 추정: $0.22/180분)

생성 완료 후 정확한 비용이 표시됩니다.

Q: .env 파일 설정을 바꾸려면?

A: .env 파일을 열어 원하는 값을 수정하세요:

# 검색 결과 증가
SEARCH_NUM_RESULTS=20

# 크롤링 범위 확대
DEEP_CRAWLER_MAX_PAGES=30

# 타임아웃 증가
WEB_SCRAPER_TIMEOUT=60

변경 후 재시작하면 바로 적용됩니다.

사용법

Q: 오프라인에서 사용 가능한가요?

A:

• 생성 시: API 필요 (OpenAI, Serper 등)
• 생성 후: HTML 파일과 지식창고는 오프라인 사용 가능
• Chat 모드: 지식창고는 오프라인 작동하지만 LLM API는 필요

Q: 품질 레벨의 차이는?

A:

레벨	임계값	용도	시간
lenient	70점	빠른 초안	짧음
balanced	80점	기본값 ✅	보통
strict	90점	고품질 프로덕션	김

임계값 미달 시 최대 3회 자동 개선합니다.

Q: Chat 모드 종료 방법은?

A: 다음 중 하나 사용:

• /exit 또는 /quit (권장)
• Ctrl+C (강제 종료)

Q: 이미지가 제대로 매칭되지 않으면?

A: v0.2.0의 Location-based 매칭이 자동으로 작동합니다:

1. PDF 이미지: 85% 자동 매칭 (페이지 기반)
2. 웹 이미지: 키워드 기반 보완
3. 수동 편집: lecture-forge edit-images로 교체 가능

기술적 질문

Q: 테스트는 어떻게 실행하나요?

# 전체 테스트
pytest tests/ -v

# 커버리지 확인
pytest tests/ --cov=lecture_forge --cov-report=html

# 특정 테스트
pytest tests/unit/agents/test_content_writer.py -v

# 특정 에이전트만
pytest tests/unit/agents/ -v

Q: API 호출이 실패하면 어떻게 되나요?

A: v0.2.0부터 자동 재시도 기능이 있습니다:

• 최대 3회 재시도
• 지수 백오프: 2초 → 4초 → 10초
• 일시적 오류 자동 복구
• OpenAI, Serper, Pexels, Unsplash 모두 지원

Q: RAG 쿼리 캐싱은 어떻게 작동하나요?

A:

• 쿼리와 결과 개수를 MD5 해시로 변환하여 메모리 캐시
• 동일 질문은 60% 빠른 응답
• 캐시 히트/미스 통계 자동 추적
• 세션 동안 유지 (프로세스 종료 시 초기화)

Q: 설정을 환경별로 다르게 하려면?

A: .env 파일을 환경별로 분리하세요:

# 개발 환경
.env.development

# 프로덕션 환경
.env.production

# 사용
cp .env.production .env
lecture-forge create

---

📝 변경 이력

v0.4.1 (2026-02-23) - 🌐 translate 명령어 & 코드 품질

• 🌐 translate 명령어 품질 대폭 개선 (pdf_translator.py)
  • _TERM_GLOSSARY 클래스 상수: AI/ML 표준 용어 25개 일관 번역 (본문에만 적용)
  • _clean_raw_text(): PDF 아티팩트 자동 제거 (페이지 번호, 도메인 워터마크, 짧은 단편)
  • _is_toc_content() + _filter_chapters(): 차례 페이지 및 30단어 미만 섹션 자동 제외
  • _translate_title() 수정: 접두어 제거 ("제목:", "타이틀:" 등), 단순 예제 추가
  • _translate_chunk() 개선: 할루시네이션 가드 (⛔ 절대 금지) 추가
  • build_curriculum(): 영어 챕터 제목 기반 학습 목표 → 고정 한국어 학습 목표로 교체
  • assign_images_to_sections(): globally_used_ids 집합으로 크로스 섹션 이미지 중복 방지
• 🎛️ --with-diagrams 플래그: translate 명령어에 Mermaid 다이어그램 생성 opt-in (기본 OFF)
• 📝 콘텐츠 메타 주석 제거 (content_expander.py): _strip_meta_commentary() — "이제 X단어를 달성하였습니다" 등 AI 상태 보고 자동 삭제
• 📄 프롬프트 개선: content_generation.txt, content_expansion.txt — 메타 주석 생성 금지 규칙 명시
• 🔢 constants.py 상수 모듈: 12개 명명된 상수 클래스 — 품질 평가 임계값, 이미지 품질 점수, RAG 파라미터, 코드 복잡도 등 magic number 제거
• 🔍 예외 처리 세분화: html_assembler, curriculum_designer, content_writer, image_extractor — 광범위한 except Exception → 구체적 예외 타입
• 🔷 타입 힌트 보완: token_tracker, retriever, qa_agent 함수 반환 타입 (-> None, Dict[str, Any])
• 🧪 테스트 수정: macOS /tmp → /private/tmp symlink 처리, 예외 mock 타입 일치

v0.4.0 (2026-02-22) - 🔍 검색·슬라이드·보강 개선

• 🔍 검색 커버리지 수정: html_assembler.py에서 [:500] 절단 제거 → 섹션 전체 내용 인덱싱 (기존 ~15% → 100%)
• 📊 --re-evaluate HTML 통계 자동 업데이트 (content_enhancer.py)
  • 사이드바·헤더 배지: 단어수·이미지수·다이어그램수 보강 후 재계산값으로 교체
  • 🕐 타임스탬프: 원본 생성 시각 → 보강 시각으로 교체
  • 푸터: "Generated by LectureForge · {보강 시각}" 업데이트
• 🎬 --to-slides 기본 LLM 재작성: --slide-rewrite 옵션 제거 → --to-slides 시 항상 섹션별 LLM 재작성 실행 (≤35자, 말줄임표 없음)
• 🐛 --with-notes hang 수정: Mermaid placeholder 방식으로 O(n²) 정규식 hang 문제 해결

v0.3.8 (2026-02-20) - 🧠 RMC 자기검토

• 🧠 RMC (Reflective Meta-Cognition) 3개 에이전트에 적용 (2단계 자기검토: Layer 1 검토 + Layer 2 검토의 검토)
  • CurriculumDesigner._review_with_rmc(): 섹션 순서 난이도, 학습목표 커버리지, 선수 내용 순서 자동 수정
  • ContentWriter._review_content_with_rmc(): 개념 비약·흐름 단절·중복 의미론적 검토 후 수정
  • QAAgent._review_answer_with_rmc(): 주장별 ✓/~/✗ 분류 → 할루시네이션 항목 제거 또는 경고
• 🐛 결론/도입 섹션 LLM 거부 응답 수정: 안전 프롬프트 + 거부 패턴 감지 자동 재시도
• 🐛 --with-notes Mermaid --> → --> 인코딩 버그 수정 (SlideNotesGenerator)
• ✅ Python 3.13 전체 의존성 호환 검증

v0.3.7 (2026-02-18) - 🖼️ UI & 슬라이드 개선

• 🖼️ Lightbox: 강의 HTML에서 이미지·Mermaid 다이어그램 클릭 시 전체화면 모달 확대
• 🔍 검색 개선: Lunr.js → 서브스트링 검색 (한국어·영어 혼합 완벽 지원)
• 📊 Mermaid 전체 너비: 슬라이드에서 ~300px → ~1180px (width: 100%)
• 🐛 Mermaid 10 API 수정: contentLoaded() → mermaid.run(), startOnLoad: false

v0.3.6 (2026-02-18) - 🔧 코드 품질 & 안정성

• 🐛 BaseAgent.temperature=0.0 falsy 버그 수정
• 🐛 QAAgent 하드코딩 경로 → Config.USER_CONFIG_DIR
• 🔧 utils/retry.py: make_api_retry() 공통 팩토리 (중복 4곳 제거)
• 🏗️ BaseImageSearchTool: Unsplash/Pexels 공통 로직 추출 (~100줄 감소)
• ⚙️ RAG 파라미터 환경변수 지원: RAG_QA_N_RESULTS, RAG_QA_TOP_K, RAG_CONTENT_N_RESULTS
• ✅ Config 검증: IMAGE_WEIGHT_*, CONTENT_*_RATIO 합계 1.0 검증
• 💬 Chat 응답 conversation_log.txt 저장 (질문 + AI 답변 모두)
• 🧪 async 도구 테스트 23개 추가

v0.3.5 (2026-02-18) - 🎯 RAG 품질 대폭 향상

• 🎯 400단어 구조화 답변: 5개 Markdown 섹션 강제 (개요/상세/핵심/예시/추가고려)
• 🔍 검색 강화: n_results 10→15, top_k 8→12 (+50%), source-page당 최대 3개 chunks
• 🌡️ temperature 0.7→0.3 (정확성 향상), Rich Markdown Panel 렌더링
• 🐛 ChromaDB L2 신뢰도 버그 수정: 1 - distance → max(0, 1 - distance/2) (항상 0% 해결)
• 🔧 pkg_resources.path → importlib.resources.files() (Python 3.11+ deprecation 제거)

v0.3.4 (2026-02-16) - ⚡ Async I/O 지원

• ⚡ AsyncContentCollectorAgent: PDF·URL·검색 병렬 처리 (70% 성능 향상)
• 🌐 Async Tools: httpx 기반 web scraper, Serper search, Rate limiting
• 🚀 --async-mode CLI 플래그 (실험적), 기존 sync 100% 호환

v0.3.3 (2026-02-15) - ⌨️ 입력 시스템 개선

• ⌨️ prompt-toolkit 도입: 한국어·멀티바이트 완벽 지원, 백스페이스/방향키 정상 작동
• 📜 입력 히스토리 (chat_history.txt), ↑/↓ 탐색, Ctrl+R 검색
• 💡 자동 제안 (이전 질문 기반), 편집 단축키 (Ctrl+A/E, Alt+←/→)
• 🔧 NumPy 1.26.0+ (Python 3.12 공식 지원)

v0.3.2 (2026-02-14) - 🌐 다국어 지원

• 🌐 자동 언어 감지: chunk 단위 언어 감지 (langdetect)
• 🔍 Cross-lingual Dual Query: 한국어 질문 → 영어 문서도 검색 (자동 번역)
• 🎯 지능형 재랭킹: 같은 언어 우선 + cross-lingual 보너스
• 🛠️ 기존 Vector DB 마이그레이션 도구 (migrate_add_language_metadata.py)

v0.3.1 (2026-02-13) - 📂 사용자 친화적 디렉토리

• 📂 ~/.lecture-forge/ (히든) → ~/Documents/LectureForge/ (일반 폴더)
• 🏠 home 커맨드 추가: outputs, data, kb, env 빠른 접근
• 🔄 자동 마이그레이션: 기존 데이터 자동 이동 (하위 호환)

v0.3.0 (2026-02-12) - 🎯 프레젠테이션 최적화

• 🎯 슬라이드당 항목 수 4→3, 긴 리스트 자동 분할 (최대 5개씩)
• 🎨 제목 크기/색상 계층화, 타이포그래피 최적화, 코드 블록 입체감
• 📊 텍스트 다이어그램 → Mermaid 변환 (아키텍처, 예외 계층, 품질 평가)
• 🎯 예외 처리 시스템 (9개 카테고리) + 템플릿 기반 프롬프트 관리

v0.2.6 (2026-02-12) - 🐛 이미지 버그 수정

• 🐛 pil_image.thumbnail() 원본 수정 버그 수정 → pil_image.copy() 후 분석
  • 증상: 모든 PDF 이미지가 200px 너비로 저장됨 → 원본 크기 완전 보존

v0.2.1–0.2.5 (2026-02-10~12) - 버그 수정 및 품질 개선

• 🐛 Visual score, 품질 평가, 슬라이드 생성 버그 수정
• 🎨 이미지 Full HD·고품질 WebP, IMAGE_MIN_WIDTH=500 강화

v0.2.0 (2026-02-09) - 🚀 Enhanced Quality Release

• ⚡ RAG 쿼리 캐싱 (60% 성능 향상), 자동 API 재시도 (지수 백오프)
• 🧪 77+ 단위 테스트, 타입 힌트 40% → 75%
• 🔧 Config 리팩토링: 모든 하드코딩 제거, 15+ 환경변수 기반 설정

v0.1.0 (2026-02-08) - 🎉 Initial Release

• 10개 전문 에이전트, 멀티소스 수집 (PDF·URL·검색)
• Location-based 이미지 매칭 (+750%), ChromaDB 지식창고
• 6차원 품질 평가, HTML 출력, Reveal.js 슬라이드 변환

---

🤝 기여하기

기여를 환영합니다! 다음 절차를 따라주세요:

1. 이슈 생성: 변경사항을 먼저 논의
2. 포크 & 브랜치: feature 브랜치 생성
3. 테스트 작성: 새 기능에 대한 테스트 추가
4. PR 제출: 변경사항 설명과 함께 제출

자세한 내용은 CONTRIBUTING.md를 참조하세요.

---

📄 라이선스

MIT License - 자세한 내용은 LICENSE 참조

---

📞 지원 및 문의

• 이슈 트래커: GitHub Issues
• 프로젝트 가이드: CLAUDE.md
• 기술 분석: INPUT_LIMITS_ANALYSIS.md
• 테스트 가이드: tests/README.md

---

🙏 감사의 말

이 프로젝트는 다음 오픈소스 프로젝트들을 활용합니다:

• LangChain - Multi-Agent 프레임워크
• ChromaDB - 벡터 데이터베이스
• OpenAI - GPT-4o 모델
• Serper - 검색 API
• Pexels & Unsplash - 이미지 API

---

Made with ❤️ by Sungwoo Kim
⭐ 이 프로젝트가 도움이 되었다면 GitHub Star를 눌러주세요!