Skip to main content

A lightweight Python library for fetching YouTube videos' metadata.

Project description

Meta-YT


Logo

Meta-YT

Meta-YT is a lightweight Python library for fetching YouTube video metadata. It allows users to interact with YouTube videos, captions, and playlists, making it easier to retrieve information and captions from YouTube.

Submit Issues · Releases

GitHub Forks GitHub Stars License Github Watchers

Key Features

  • Video Metadata: Retrieve detailed metadata for YouTube videos, including title, duration, views, thumbnails, and more.
  • Captions: Fetch and process captions (subtitles) for YouTube videos.
  • YouTube Search: Perform YouTube searches and fetch metadata for the top results.

Installation

Install Meta-YT using pip:

pip install meta-yt

Usage

Here is a quick guide on how to use the library.

Importing Necessary Modules

from meta_yt import YouTube, Video, Caption

Initializing the YouTube Object

You can initialize the YouTube object either with a search query or a video URL.

Using a Search Query

yt = YouTube("cat videos")
print(yt.video.title)

Using a Video URL

yt = YouTube("https://www.youtube.com/watch?v=dQw4w9WgXcQ", isUrl=True)
print(yt.video.title)

Fetching Captions

You can fetch captions for a video and convert them to SubRip (SRT) format.

captions = yt.video.get_captions(include_generated=True)
for lang, caption in captions.items():
    print(f"Captions in {lang}:")
    for line in caption.transcript:
        print(f"{line['start']} - {line['end']}: {line['text']}")

Since this library does not include a function to download or decrypt video streams, you will need to use external libraries such as YTDL or PyTube for those purposes.

API Reference

class YouTube

Represents a YouTube video and provides metadata fetching functionality.

__init__(self, query: str, isUrl: bool = None)

Initializes a YouTube object.

Args:

  • query (str): The search query or video URL.
  • isUrl (bool, optional): Whether the query is a URL. Defaults to None.

class Video

Represents a YouTube video and provides methods to fetch metadata and captions.

__init__(self, videoId: str)

Initializes a Video object.

Args:

  • videoId (str): The ID of the YouTube video.

Attributes

  • video_id The video ID.
  • url: The URL of the YouTube video.
  • title: The title of the video.
  • channel: The channel name of the video.
  • duration: The duration of the video.
  • views: The number of views on the video.
  • thumbnail: The URL of the video thumbnail.
  • thumbnails: A list of all URLs of video thumbnails.
  • channel_url: The URL of the video channel.
  • channel_id: The ID of the video channel.
  • keywords: A list of keywords of the video.
  • metadata: Additional metadata fetched from the YouTube API.

get_captions(self, include_generated: bool = False) -> list

Fetches the captions for the video.

Args:

  • include_generated (bool, optional): Whether to include auto-generated captions. Defaults to False.

Returns:

  • captions: A list of Caption objects.

class Caption

Represents captions for a YouTube video.

__init__(self, baseUrl: str, language_code: str)

Initializes a Caption object.

Args:

  • baseUrl (str): The base URL of the video.
  • language_code (str): The ISO 639-1 language code of the captions.

Attributes

  • url: The URL for fetching captions.
  • language_code: The ISO 639-1 language code of the captions.
  • language: The language name of the captions.
  • transcript: A list containing dictionaries representing each line of the transcript.

to_srt(self) -> str

Converts the transcript to SubRip (SRT) format.

Returns:

  • str: The transcript in SubRip (SRT) format.

Contributing

We welcome contributions! Please fork the repository and submit pull requests.

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meta_yt-0.1.5.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

meta_yt-0.1.5-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file meta_yt-0.1.5.tar.gz.

File metadata

  • Download URL: meta_yt-0.1.5.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for meta_yt-0.1.5.tar.gz
Algorithm Hash digest
SHA256 c7595b79504765dee960e760b7b99ae48e5f1f10bbb804446a41ed6382ade942
MD5 5846140af8bdca8b42fd59f0cc0a46c0
BLAKE2b-256 c7ff78497801f28e70f7425fdeb3463686afd0efd3b632129b8639c8d2cef1bf

See more details on using hashes here.

File details

Details for the file meta_yt-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: meta_yt-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for meta_yt-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7c4afc6748792533be9ac962cc3c59f1ad3b449f1d14fc63bc40d3ebe5d36f06
MD5 5f87c1e953c34e9cc0a073f43addd421
BLAKE2b-256 446dbc79c1bce94b60cab7102d718ada19a00757572459b16462380eefd7121e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page