StudyBot

A note taking assistant that helps you summarize educational YouTube videos into concise study notes.

Project created during Hack Your Portfolio hackathon event hosted by MLH (Major League Hacking).

Installation

Setup Ollama server

1. Download Ollama from ollama.com/download following the installation instructions provided by Ollama's website.
2. Once ollama is installed, open terminal or command prompt and pull the gemma2:9b model:

   ollama pull gemma2:9b
   

3. Start the local ollama server:

   ollama serve
   

Setup StudyBot environment and install dependancies

1. Clone the repository:

   git clone https://github.com/RobH0/StudyBot.git
   

2. Create Python3 virtual environment and activate it:

   # Linux create venv
   python3 -m venv env
   # Linux activate venv
   source env/bin/activate
   
   # Windows create venv
   python -m venv env
   # Windows activate venv
   venv\Scripts\activate
   

3. Install python3 dependancies:

   pip install -r requirements.txt
   

Usage

1. Make sure Ollama server is running:

   ollama serve
   

2. Execute the study_bot.py script:

   # Linux
   python3 study_bot.py
   
   # Windows
   python study_bot.py
   

3. Respond to prompts displayed in your terminal.

How it works

A user is prompted to provide a URL to a YouTube video and pick a filename that will be used when the generated notes are saved to disk.

Once the user enters the prompted information into the CLI, the 'study_bot.py' script retrieves the YouTube video's title and English language transcript.

The YouTube video title and its transcript are used in a prompt that instructs the Gemma2 LLM (Large Language Model), run by Ollama, to summarize the transcript of the video into a concise study note document.

Once Gemma2 has finished generating the study note, it is saved as a Markdown file on disk, allowing the user to view it whenever required.