YouTube Caption Search Tool (CapScript)

Overview

CapScript is a Python console script that utilizes the YouTube Data API and the YouTube Transcript API to search for specific words or phrases within the captions (subtitles) of YouTube videos. The tool allows users to perform targeted searches across individual videos, multiple videos specified through a list, or videos associated with a particular YouTube channel. The matching captions and corresponding timestamps are collected and saved to a text file for easy reference.

YouTube Caption Search Tool (CapScript)

Features

• Supports search for words or phrases in YouTube video captions.
• Three search modes available: Video ID(s), Channel ID, or Video ID(s) from a file.
• User can specify the number of videos to search for when searching by channel.
• Allows selection of the language for caption search (default: English - "en").
• Saves and loads preferences, including the YouTube Data API key.
• Displays progress during the search and estimated time of completion.

Prerequisites

1. YouTube Data API Key: The script requires a valid YouTube Data API key. If you don't have one, you can obtain it by following the YouTube API Documentation.

2. Python version >= 3.7: Download Python

3. Python Libraries: Ensure you have the following Python libraries installed:

   • youtube_transcript_api
   • googleapiclient
   • google-auth-oauthlib
   • configparser

   You can install them using pip:

   pip install youtube-transcript-api google-api-python-client google-auth-httplib2 google-auth-oauthlib configparser
   

4. Monospaced Font for Terminal: To ensure proper display of Unicode characters in the terminal, it's recommended to use a monospaced font. Most modern terminals and command prompts support Unicode characters, but a monospaced font can improve readability. Some common monospaced fonts include "Courier New," "Consolas," "DejaVu Sans Mono," or "Monaco." [Most terminals opt for a (ttf) by default]

Usage

1. API Key Configuration: Before running the script, you need to configure the YouTube Data API key. If you have not set it previously or want to change it, the script will prompt you to enter a valid API key.

2. Download the CapScript.py file or use git clone:

   git clone https://github.com/yanpuri/CapScript.git
   

3. Inside the directory of the installation, run the script:

   python CapScript.py
   

4. Search Mode Selection: The script will prompt you to choose a search mode: "Channel" or "Video".

   • "Channel": You will be asked to enter the YouTube channel ID, the number of videos to search, and the caption language.
   • "Video": You can either enter individual video IDs separated by commas or provide a path to a file containing the video IDs.

5. Search Term Input: After selecting the search mode, enter the word or phrase you want to search for within the captions.

6. Results: The script will begin the search process and display a progress indicator. After completion, it will show the total number of matches found. The matching captions and corresponding timestamps will be saved in a text file inside the "transcripts" folder.

Obtaining a YouTube Data API Key

To use CapScript, you need a valid YouTube Data API key. Follow the steps below to obtain one:

1. Create a Google Developer Console Project: Go to the Google Developer Console and create a new project.

2. Enable YouTube Data API: Inside your project, navigate to the "APIs & Services" > "Dashboard" and click on the "+ ENABLE APIS AND SERVICES" button. Search for "YouTube Data API v3" and enable it.

3. Create Credentials: In the left-hand menu, click on "Credentials" > "Create Credentials" > "API key". A pop-up will appear, showing your API key.

4. Restrict API Key (Optional but Recommended): To improve security, restrict the API key usage to only the APIs you need. You can set restrictions for the YouTube Data API within the "Credentials" settings.

Finding a YouTube Channel ID

To search for videos associated with a specific YouTube channel, you need a unique Channel ID. Here's how you can find it:

1. Open YouTube Channel: Go to the YouTube channel you want to search within your web browser.

2. View Page Source: Right-click on the page (anywhere) and select "View Page Source" or "Inspect" from the context menu.

3. Search for Channel ID: In the page source view, press Ctrl+F (Windows/Linux) or Cmd+F (Mac) to open the search function. Enter ?channel_id in the search box.

4. Locate the Channel ID: The search will highlight the "?channel_id" parameter in the page source, and the value next to it will be the Channel ID. It will typically be a string of letters and numbers.

Notes

• The preferences.ini file will be created and used to store the API key. This ensures you don't need to re-enter the key each time you run the script.
• The script will skip videos without available captions or with disabled subtitles.
• If you run the script multiple times, make sure to use the same API key to avoid API usage issues.

Important: The script uses the YouTube Data API, which has request quotas and limitations. Make sure to respect the API usage guidelines to avoid potential restrictions.

Images

Channel search:

Video search (list):

Output:

Support Me

If you liked this, please consider leaving a star ⭐

If you found this to be useful, make sure to follow me for more 🙃