An intelligent study companion powered by AI to help students with various subjects and topics.
- Text-based Q&A
- Image processing and analysis
- PDF text extraction and analysis
- Topic-specific hints (General, Coding, Math, Science)
- Chat history for each input type
- Python 3.7+
- Streamlit
- Groq API
- PyTesseract (OCR)
- PyMuPDF (PDF processing)
- streamlit
- groq
- pytesseract
- Pillow (PIL)
- PyMuPDF (fitz)
- requests
-
Clone the repository:
git clone https://github.com/muhammad-farhan67/AI-Study-Assistant.git cd AI-Study-Assistant -
Install the required libraries:
pip install -r requirements.txt -
Set up your Groq API key:
- Create a
.streamlit/secrets.tomlfile in your project directory - Add your Groq API key to the file:
GROQ_API_KEY = "your-api-key-here"
- Create a
-
Install Tesseract OCR:
- For Windows: Download and install from GitHub
- For macOS:
brew install tesseract - For Linux:
sudo apt-get install tesseract-ocr
-
Update the Tesseract path in the code if necessary:
pytesseract.pytesseract.tesseract_cmd = r'path/to/tesseract'
-
Run the Streamlit app:
streamlit run app.py
-
Create a Streamlit account at streamlit.io
-
Connect your GitHub repository to Streamlit
-
Create a new app and select your repository
-
Add your Groq API key to the Streamlit secrets:
- Go to your app settings
- Navigate to the "Secrets" section
- Add your Groq API key as
GROQ_API_KEY
-
Deploy your app
-
Your AI Study Assistant is now live and accessible via the provided Streamlit URL!
Contributions, issues, and feature requests are welcome! Feel free to check the issues page.
This project is MIT licensed.
- Groq for providing the AI model API
- Streamlit for the awesome web app framework
- PyTesseract and PyMuPDF for image and PDF processing capabilities