Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 2.54 KB

README.md

File metadata and controls

79 lines (56 loc) · 2.54 KB

VideoRecap

Overview

With this project, users can enter a YouTube URL link to gain a quick summary of the video, allowing users to save time as well as having a few short consise sentence to refer back to and make note of. This can also apply to interview questions as well as programming tutorials. These texts can be a summary of how you should tackle them.

Prerequisites

  • Python JDK 11+
  • Environment variables configured:
  • Can be found by making an account and creating a key: openrouter website
   openrouter_api_key: your openrouter api_key
  • Configuring Potoken (Follow instructions under 'Manually acquiring a PO Token from a browser for use when logged out')
   https://github.com/JuanBindez/pytubefix/pull/209

Technical Stack

  • Python
  • HTML/CSS

Installation

  1. Clone the repository 
    git clone https://github.com/Keepas3/Hackathon_HeadStarter.git
  2. Create virtual environment to isolate dependencies (Optional) 
    python -m venv myproject_env
  3. Download all dependencies (can take up to 10+ minutes) 
    pip -r requirements.txt
  4. Run Python file 
    python video_recap.py

Import Information:

video_recap.py makes use of the transcript generated by Youtube through the import of YoutubeTranscriptApi, meaning this application will not work if captions are entirely disabled. Pytubefix gives access to YouTube videos and lets you retrieve basic information about the video content. Potoken is used to verify the request is made from an actual user and not a bot. YoutubeTranscriptApi allows access to using youtube's captions or transcripts and allows the code to read it. SentenceTransformers is the natural language model used to summarize the transcript through the use of api keys.

Running the Application:

After completing all preresiquites and installation, video_recap.py will give a prompt to enter a url. Be free to enter any type of youtube video and copy the link into the terminal. Upon entering, the VideoRecap will first verify information about the video including how many lines the video contains. Then the summary will be contained in a file of the source folder containing the completed summary of the video.

Additional Resources:

https://openrouter.ai/

https://huggingface.co/

Contributors:

Vignesh S, Vignesh

Bryan F, Bryan

Justin L, Justin

Kevin Y, Kevin