Skip to content

LeonardoLBraga/SmartStudyBot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SmartStudyBot Banner

SmartStudyBot Logo

🤖 SmartStudyBot

Your AI-powered personalized study companion built using Python, NLP, and speech tools.

GitHub contributors PRs Welcome


🧠 Features

  • Summarize any topic using NLP techniques
  • Get real-time study resource links
  • Hear explanations using text-to-speech
  • Practice multiple-choice questions by topic
  • Modular design, beginner-friendly codebase

🛠️ Tech Stack

  • Python 3.10+
  • sumy – for summarization
  • pyttsx3 or gTTS – for speech output
  • requests – for fetching resources
  • JSON – for MCQ data
  • Optional: Gemini API or Streamlit for future upgrades

🚀 Getting Started

Clone this repository and install dependencies:

git clone https://github.com/imDarshanGK/SmartStudyBot.git
cd SmartStudyBot
python -m venv venv
source venv/bin/activate    # On Windows: venv\Scripts\activate
pip install -r requirements.txt
python main.py

🧾 Project Structure

SmartStudyBot/
├── main.py
├── config.py
├── requirements.txt
├── modules/
│   ├── summarize.py
│   ├── tts.py
│   ├── resource_fetcher.py
│   └── question_recommender.py
├── data/
│   └── questions/
│       ├── python.json
│       └── dsa.json
└── .github/
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATE.md
    └── PULL_REQUEST_TEMPLATE.md

🎮 Features in Action

  • Select a study action via menu
  • Automatically summarizes topics
  • Speaks any content via TTS
  • Asks 5 MCQs and shows your score
  • Fetches resource links for further study

🧑‍💻 Contributing

We ❤️ contributions from the community!

# 1. Fork this repo
# 2. Create a feature branch
git checkout -b feature-name

# 3. Make your changes
git add .
git commit -m "Add a new feature"
git push origin feature-name

# 4. Create a Pull Request

See CONTRIBUTING.md for full guidelines.


🐛 Issues

Check out our Issues tab
Look for labels like good first issue, enhancement, or documentation.


📄 License

This project is licensed under the MIT License.


💬 Looking for Contributors

We welcome beginner-friendly contributions!
🌟 Star the repo and check the issues to get started.

About

Your AI-powered personalized study companion built using Python, NLP, and speech tools.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages