SnapScrib

About   |   Technologies   |   Requirements   |   Starting   |   License

Contributors

Cipher Shadow   |   Arved Bahde   |   Miriam

:dart: About

SnapScrib is a Python-based web application that retrieves subtitles from YouTube videos and summarizes them using the Groq API. Users can customize the language of the summary according to their preferences.

:rocket: Technologies

• Programming Language: Python
• Main Libraries:
  • youtube_transcript_api: For retrieving subtitles from YouTube videos.
  • groq: For summarizing the retrieved subtitles.
• Web UI: SnapScrib provides a user-friendly interface where users can input the YouTube URL and choose the language for the summary.

:white_check_mark: Requirements

Before starting :checkered_flag:, you need to have Git installed.

:checkered_flag: Starting

1. Clone the repository:

   git clone https://github.com/JAM-Solutionss/SnapScrib.git
   cd SnapScrib

2. Install dependencies:

   pip install -r requirements.txt

Configuration

Create a .env file in the project directory and add your Groq API key as follows:

GROQ_API_KEY="your_api_key_here"

Usage

1. Visit the Website: Start the application and navigate to the web interface.
2. Enter YouTube URL: Provide the URL of the YouTube video you want to summarize.
3. Select Language: Choose the language in which the summary should be created.
4. Receive Summary: The subtitles will be retrieved, sent to the Groq API, and the summary will be provided in the selected language.

Project Structure

• requirements.txt: List of Python dependencies.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Collaborate

If you have any questions or need further assistance, please feel free to contact any of the contributors. Happy coding!

Made with :heart: by:

• Arved Bahde
• Jannis Krija
• Miriam

Back to top