Add --version option to CLI

Author: sderev

youtube_transcript_api/_cli.py

@@ -1,10 +1,17 @@
 import argparse
+from importlib.metadata import PackageNotFoundError, version
 from typing import List
 
-from .proxies import GenericProxyConfig, WebshareProxyConfig
+from ._api import FetchedTranscript, TranscriptList, YouTubeTranscriptApi
 from .formatters import FormatterLoader
+from .proxies import GenericProxyConfig, WebshareProxyConfig
+
 
-from ._api import YouTubeTranscriptApi, FetchedTranscript, TranscriptList
+def get_version():
+    try:
+        return version("youtube-transcript-api")
+    except PackageNotFoundError:
+        return "unknown"
 
 
 class YouTubeTranscriptCli:
@@ -99,6 +106,9 @@ def _parse_args(self):
                 "other selenium based solutions do!"
             )
         )
+        parser.add_argument(
+            "--version", action="version", version=f"%(prog)s, version {get_version()}"
+        )
         parser.add_argument(
             "--list-transcripts",
             action="store_const",

youtube_transcript_api/test/test_cli.py

@@ -1,14 +1,16 @@
-import pytest
+import json
+import subprocess
+from importlib.metadata import PackageNotFoundError, version
 from unittest import TestCase
-from unittest.mock import MagicMock
+from unittest.mock import MagicMock, patch
 
-import json
+import pytest
 
 from youtube_transcript_api import (
-    YouTubeTranscriptApi,
-    VideoUnavailable,
     FetchedTranscript,
     FetchedTranscriptSnippet,
+    VideoUnavailable,
+    YouTubeTranscriptApi,
 )
 from youtube_transcript_api._cli import YouTubeTranscriptCli
 
@@ -333,10 +335,36 @@ def test_run__generic_proxy_config(self):
     )
     def test_run__cookies(self):
         YouTubeTranscriptCli(
-            ("v1 v2 --languages de en " "--cookies blahblah.txt").split()
+            ("v1 v2 --languages de en --cookies blahblah.txt").split()
         ).run()
 
         YouTubeTranscriptApi.__init__.assert_any_call(
             proxy_config=None,
             cookie_path="blahblah.txt",
         )
+
+    def test_version_matches_metadata(self):
+        """
+        `youtube_transcript_api --version` should return the same version as in the package metadata.
+        """
+        expected_version_msg = (
+            f"youtube_transcript_api, version {version('youtube-transcript-api')}"
+        )
+
+        cli_version_msg = subprocess.run(
+            ["youtube_transcript_api", "--version"],
+            capture_output=True,
+            text=True,
+            check=True,
+        ).stdout.strip()
+
+        assert (
+            cli_version_msg == expected_version_msg
+        ), f"Expected version '{expected_version_msg}', but got '{cli_version_msg}'"
+
+    def test_get_version_package_not_found(self):
+        with patch(
+            "youtube_transcript_api._cli.version", side_effect=PackageNotFoundError
+        ):
+            from youtube_transcript_api._cli import get_version
+            assert get_version() == "unknown"