---

StudyAI ✏️

StudyAI is an intelligent desktop application designed to revolutionize the way students learn from lectures.
Too often, students fall behind due to fast-paced teaching, unclear explanations, or distractions. StudyAI bridges these gaps by transforming raw lectures into personalized, accessible, and actionable study material.

---

Features

Core Capabilities

Capture → Upload or record lecture audio with real-time transcription (Whisper).
Condense → Summarize lectures in three modes:

• Topics Only → Quick review of key concepts
• Questions Asked → Extracted Q&A from the lecture
• Detailed Summary → Narrative-style overview for deep study

Comprehend → Learn actively through two AI agents:

• Study Buddy → Explains difficult concepts in plain language
• Quiz Master → Generates personalized practice questions

---

Project Structure

LectureAI/
│── README.md
│── requirements.txt
│── .gitignore
│── main.py

# ── Core Application
│── app/
│   ├── ui.py
│   ├── notes.py
│   ├── audio.py
│   ├── transcription.py
│   ├── summarizer.py
│   ├── agents.py
│   ├── integrations.py
│   ├── storage.py
│   ├── utils.py
│   └── agents/
│       ├── study_buddy.py
│       ├── quiz_master.py
│       └── base_agent.py

# ── Assets
│── assets/
│   ├── logo.png
│   ├── icons/
│   └── styles.css (optional)

# ── Data
│── data/
│   ├── notes/
│   ├── transcripts/
│   ├── summaries/
│   ├── quizzes/
│   └── textbooks/

# ── Google Integrations
│── integrations/
│   ├── drive_api.py
│   ├── docs_api.py
│   └── gemini_api.py

---

Installation

Follow these steps to set up StudyAI locally:

# 1. Clone the repository
git clone https://github.com/itsjustgiio/StudyAI.git
cd StudyAI

# 2. (Optional but recommended) Create & activate a virtual environment

# On macOS/Linux:
python3 -m venv venv
source venv/bin/activate

# On Windows:
python -m venv venv
venv\Scripts\activate

# 3. Install dependencies
pip install -r requirements.txt

# 4. Set up environment variables or API keys

# Copy .env.example to .env (if provided)
cp .env.example .env

# Then add your API keys/credentials, such as:
# OPENAI_API_KEY=
# GOOGLE_DRIVE_CLIENT_ID=
# GOOGLE_DRIVE_CLIENT_SECRET=
# GEMINI_API_KEY=
# etc.

# 5. Run the app
python main.py

---