Merge branch 'main' of https://github.com/therohitdas/Youtube-Transcript-Generator

Author: therohitdas

main.ipynb

@@ -6,7 +6,8 @@
       "provenance": [],
       "gpuType": "T4",
       "mount_file_id": "15KTDpG-Cy2JIQo_r4uFYGOYv3cuuySLE",
-      "authorship_tag": "ABX9TyPcHpr7YSquXs5tHG6vgXBC"
+      "authorship_tag": "ABX9TyOOFv7bxULf3jxYdyCciRs+",
+      "include_colab_link": true
     },
     "kernelspec": {
       "name": "python3",
@@ -18,6 +19,16 @@
     "accelerator": "GPU"
   },
   "cells": [
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "view-in-github",
+        "colab_type": "text"
+      },
+      "source": [
+        "<a href=\"https://colab.research.google.com/github/therohitdas/Youtube-Transcript-Generator/blob/main/main.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
+      ]
+    },
     {
       "cell_type": "markdown",
       "source": [
@@ -48,7 +59,11 @@
         "\n",
         "## Environment Variables 🌐\n",
         "\n",
-        "- `GOOGLE_API_KEY`: Set up your Google API key for video information retrieval. You will need to create a Project in the google cloud for this and enable the YouTube v3 API. This is optional, if you don't add it, the chapters will not be added.\n",
+        "- `YOUTUBE_API_KEY`: Set up your Google API key for video information retrieval. You will need to create a Project in the google cloud for this and enable the YouTube v3 API. This is optional, if you don't add it, the chapters will not be added.\n",
+        "\n",
+        "## Runtime\n",
+        "Please go to `Runtime > Change runtime type > Select T4 GPU`\n",
+        "This will ensure best performance. Without a gpu, the punctuation will be very slow and can take minutes.\n",
         "\n",
         "## Script Parameters 📜\n",
         "```python\n",
@@ -96,12 +111,53 @@
       "execution_count": null,
       "outputs": []
     },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "**Example Usage:**\n",
+        "```python\n",
+        "url = 'https://www.youtube.com/watch?v=YOUR_VIDEO_ID' # youtu.be link works too\n",
+        "language = 'en'\n",
+        "punctuated = True # Default False, takes significantly more time when enabled on CPU, use T4 GPU type in google collab.\n",
+        "output_dir = '.' # add /content/drive/MyDrive/ to save content in You Google Drive\n",
+        "filename = \"\" # Leave empty for default filename: Video Title or Video Id\n",
+        "punctuation_model = '' # More info down below\n",
+        "verbose = True # To get logs\n",
+        "```\n",
+        "`language` use the language code to get the video. By default this module always picks manually created transcripts over automatically created ones, if a transcript in the requested language is available both manually created and generated.\n",
+        "\n",
+        "`punctuation_model` values can be found at https://huggingface.co/oliverguhr/fullstop-punctuation-multilang-large#languages\n",
+        "\n",
+        "After filling the cell below, press `CMD+F9` / `CTRL+F9` to run all cells."
+      ],
+      "metadata": {
+        "id": "U5fmwoG6UFDd"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "url = 'https://www.youtube.com/watch?v=YOUR_VIDEO_ID'\n",
+        "language = 'en'\n",
+        "punctuated = True # Default False, takes significantly more time when enabled on CPU, use T4 GPU type in google collab.\n",
+        "output_dir = '.' # add /content/drive/MyDrive/ to save content in You Google Drive, In the cell below, Uncomment the mount line\n",
+        "filename = \"\" # Leave empty for default filename: Video Title or Video Id\n",
+        "punctuation_model = ''\n",
+        "verbose = True"
+      ],
+      "metadata": {
+        "id": "5CT6UxWtUYOn"
+      },
+      "execution_count": null,
+      "outputs": []
+    },
     {
       "cell_type": "code",
       "source": [
         "# Run this if you want to mount and store generated files in google drive.\n",
         "from google.colab import drive\n",
         "\n",
+        "# Uncomment this:\n",
         "# drive.mount(\"/content/drive\")"
       ],
       "metadata": {
@@ -117,12 +173,12 @@
         "import logging\n",
         "import re\n",
         "import math\n",
+        "import nltk\n",
         "import youtube_transcript_api\n",
         "from deepmultilingualpunctuation import PunctuationModel\n",
-        "import nltk\n",
-        "import warnings\n",
         "import googleapiclient.discovery\n",
         "import googleapiclient.errors\n",
+        "\n",
         "from google.colab import userdata\n",
         "import warnings"
       ],
@@ -298,7 +354,7 @@
         "def getVideoInfo (video_id):\n",
         "  try:\n",
         "    # Set up Google API credentials using API key\n",
-        "    api_key =  userdata.get('GOOGLE_API_KEY') # Replace with your actual API key\n",
+        "    api_key =  userdata.get('YOUTUBE_API_KEY') # Replace with your actual API key\n",
         "    youtube = googleapiclient.discovery.build(\"youtube\", \"v3\", developerKey=api_key)\n",
         "    request = youtube.videos().list(part=\"id,snippet\",\n",
         "                                id = video_id\n",
@@ -318,44 +374,6 @@
       "execution_count": null,
       "outputs": []
     },
-    {
-      "cell_type": "markdown",
-      "source": [
-        "## Example Usage:\n",
-        "```python\n",
-        "url = 'https://www.youtube.com/watch?v=YOUR_VIDEO_ID' # youtu.be link works too\n",
-        "language = 'en'\n",
-        "punctuated = True # Default False, takes significantly more time when enabled on CPU, use T4 GPU type in google collab.\n",
-        "output_dir = '.' # add /content/drive/MyDrive/ to save content in You Google Drive\n",
-        "filename = \"\" # Leave empty for default filename: Video Title or Video Id\n",
-        "punctuation_model = '' # More info down below\n",
-        "verbose = True # To get logs\n",
-        "```\n",
-        "`language` use the language code to get the video. By default this module always picks manually created transcripts over automatically created ones, if a transcript in the requested language is available both manually created and generated.\n",
-        "\n",
-        "`punctuation_model` values can be found at https://huggingface.co/oliverguhr/fullstop-punctuation-multilang-large#languages"
-      ],
-      "metadata": {
-        "id": "U5fmwoG6UFDd"
-      }
-    },
-    {
-      "cell_type": "code",
-      "source": [
-        "url = 'https://www.youtube.com/watch?v=CBYhVcO4WgI'\n",
-        "language = 'en'\n",
-        "punctuated = True # Default False, takes significantly more time when enabled on CPU, use T4 GPU type in google collab.\n",
-        "output_dir = '.' # add /content/drive/MyDrive/ to save content in You Google Drive\n",
-        "filename = \"\" # Leave empty for default filename: Video Title or Video Id\n",
-        "punctuation_model = ''\n",
-        "verbose = True"
-      ],
-      "metadata": {
-        "id": "5CT6UxWtUYOn"
-      },
-      "execution_count": null,
-      "outputs": []
-    },
     {
       "cell_type": "code",
       "source": [
@@ -394,4 +412,4 @@
       "outputs": []
     }
   ]
-}
+}