Skip to content

vidhitamittal/study_sprint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🎓 Study Sprint: AI Study Buddy

Study Sprint is a lightweight, AI-powered educational tool that transforms dense lecture notes and messy text into structured, downloadable study guides.

✨ Features

  • Smart Summarization: Get a high-level 3-sentence overview of any topic.
  • Key Concepts: Automatically extracts bulleted key terms and definitions.
  • Instant Quizzing: Generates challenging multiple-choice questions to test your knowledge.
  • Dual Input: Upload PDFs directly or paste raw text.
  • PDF Export: Download your generated guide as a clean PDF for offline studying.

🛠️ Tech Stack

🚀 Getting Started

Prerequisites

Installation

  1. Clone the repository:
  1. Install dependencies:
  • pip install -r requirements.txt
  1. Set up your API Key:
  • Create a .env file or replace the placeholder in app.py:
  1. Run the app:
  • streamlit run app.py

📝 Usage

  • Open the app in your browser (usually localhost:8501).
  • Upload a PDF of your notes OR paste your text into the box.
  • Click Generate Study Guide.
  • Review your guide on-screen and click Download Guide as PDF to save it.

🤝 Contributing

  • Found a bug? Have a feature idea? Feel free to open an issue or submit a pull request!

About

An AI study guide generator

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages