15

"제출 전에 이것만 확인하세요" - 최종 체크리스트

Day 5: 제조 매뉴얼 Q&A 챗봇

학습 목표

프로젝트 제출 전 확인해야 할 항목을 파악한다 흔한 실수를 미리 방지한다

최종 프로젝트 체크리스트


필수 기능 (통과 기준)

[코드]
□ manufacturing_chatbot.py가 streamlit run으로 실행되는가?
□ 에러 없이 대화가 3회 이상 진행되는가?
□ 분야 전환 시 시스템 프롬프트가 변경되는가?
□ 스트리밍 응답이 실시간으로 표시되는가?
□ 대화 초기화가 동작하는가?

[보안]
□ API 키가 코드에 직접 포함되어 있지 않은가?
□ .env 파일이 .gitignore에 추가되어 있는가?
□ .env.example 파일이 제공되는가?

[파일]
□ manufacturing_chatbot.py
□ requirements.txt
□ .env.example
□ .gitignore
□ README.md

자주 하는 실수 TOP 5

1. requirements.txt 누락
   pip freeze > requirements.txt
   → openai, streamlit, python-dotenv 포함 확인

2. .env.example 누락
   # .env.example
   OPENAI_API_KEY=sk-여기에-실제-키-입력

3. README.md 설치 방법 누락
   # 설치 및 실행
   pip install -r requirements.txt
   cp .env.example .env
   # .env에 API 키 입력
   streamlit run manufacturing_chatbot.py

4. 하드코딩된 경로
   나쁨: client = OpenAI(api_key="sk-...")
   좋음: client = OpenAI()  # 환경변수 자동 사용

5. 에러 처리 누락
   API 호출을 try/except로 감싸지 않으면
   네트워크 에러에서 앱이 크래시됨

평가 기준

항목배점기준
기능 완성도40%필수 기능 모두 동작
코드 품질25%구조, 명명, 에러 처리
문서화20%README, 주석, 스크린샷
추가 기능15%내보내기, 비용 추적 등

README.md 템플릿

# 제조 AI 어시스턴트 v2.0

제조 현장 전문 AI 챗봇 (CNC, PLC, 품질, 보전)

## 스크린샷
(여기에 실행 화면 캡처)

## 기능
- 4개 제조 분야별 전문 Q&A
- 실시간 스트리밍 응답
- 에러 처리 및 자동 재시도
- 대화 내보내기 (Markdown)
- 비용 실시간 추적

## 설치 및 실행
\`\`\`bash
pip install -r requirements.txt
cp .env.example .env
# .env에 OpenAI API 키 입력
streamlit run manufacturing_chatbot.py
\`\`\`

## 기술 스택
- Python 3.10+
- Streamlit 1.40+
- OpenAI API (GPT-4o-mini)
AI로 학습하기 — 꿀팁
🤖프로젝트 제출 전 자동 검증 스크립트AI 학습 팁

제출 전 체크리스트를 수동으로 확인하는 대신 Python으로 자동화하면 실수를 줄일 수 있습니다.

Week 1 최종 프로젝트(Streamlit 제조 챗봇) 제출 전 자동 검증 Python 스크립트를 작성해주세요. 검증 항목: (1) app.py 존재 및 streamlit import 포함 여부, (2) requirements.txt 존재 및 openai/streamlit 패키지 명시 여부, (3) .env 파일이 .gitignore에 등록됐는지 확인(API 키 노출 방지), (4) session_state 사용 여부 코드 파싱, (5) try-except 에러 처리 존재 여부. 각 항목 PASS/FAIL 출력 + 실패 시 수정 방법 안내 메시지 포함. 실행 명령어: python check_submission.py
이 팁이 도움이 됐나요?