pytubekit package

Submodules

pytubekit.configs module

All configurations

class pytubekit.configs.ConfigAddData

Bases: Config

Parameters for add_data

input_file = <pytconf.param.Unique object>

output_csv = <pytconf.param.Unique object>

class pytubekit.configs.ConfigAddFileToPlaylist

Bases: Config

Add videos from a file to a playlist

add_file = <pytconf.param.Unique object>

add_playlist = <pytconf.param.Unique object>

class pytubekit.configs.ConfigBudget

Bases: Config

API quota budget parameters

max_mutations = None

class pytubekit.configs.ConfigChannelId

Bases: Config

Channel ID options

watch_later = False

class pytubekit.configs.ConfigCleanup

Bases: Config

Parameters for cleanup

dedup = True

deleted = True

privatized = True

class pytubekit.configs.ConfigCleanupPlaylists

Bases: Config

Playlists to clean up

cleanup_names = []

class pytubekit.configs.ConfigClear

Bases: Config

Playlist to clear

clear_name = <pytconf.param.Unique object>

class pytubekit.configs.ConfigCollectIds

Bases: Config

Collect IDs parameters

collect_files = []

class pytubekit.configs.ConfigCreatePlaylist

Bases: Config

Create playlist parameters

create_description = ''

create_name = <pytconf.param.Unique object>

create_privacy = 'public'

class pytubekit.configs.ConfigDelete

Bases: Config

Configs for doing delete

do_delete = True

class pytubekit.configs.ConfigDeletePlaylist

Bases: Config

Delete playlist parameters

delete_playlist_name = <pytconf.param.Unique object>

class pytubekit.configs.ConfigDiff

Bases: Config

Parameters for diff

diff_a_files = []

diff_a_playlists = []

diff_b_files = []

diff_b_playlists = []

diff_output_file = None

diff_reverse = False

class pytubekit.configs.ConfigDump

Bases: Config

Parameters for dumping

dump_folder = '.'

class pytubekit.configs.ConfigExportCsv

Bases: Config

Export playlist to CSV parameters

export_csv_path = <pytconf.param.Unique object>

export_playlist_name = <pytconf.param.Unique object>

class pytubekit.configs.ConfigFindVideo

Bases: Config

Find video parameters

find_video_id = <pytconf.param.Unique object>

class pytubekit.configs.ConfigLocalDiff

Bases: Config

Local diff parameters

local_diff_a = <pytconf.param.Unique object>

local_diff_b = <pytconf.param.Unique object>

local_diff_reverse = False

class pytubekit.configs.ConfigLocalDumpFolder

Bases: Config

Local dump folder to operate on

local_dump_folder = '.'

class pytubekit.configs.ConfigMerge

Bases: Config

Merge parameters

merge_dedup = True

merge_destination = <pytconf.param.Unique object>

merge_sources = []

class pytubekit.configs.ConfigOverflow

Bases: Config

Overflow parameters

destination = <pytconf.param.Unique object>

source = <pytconf.param.Unique object>

class pytubekit.configs.ConfigPagination

Bases: Config

Pagination parameters

page_size = 50

class pytubekit.configs.ConfigPlaylist

Bases: Config

Playlist parameters

name = None

playlist_id = None

class pytubekit.configs.ConfigPlaylists

Bases: Config

Playlists to use

names = []

class pytubekit.configs.ConfigPrint

Bases: Config

How to dump things

full = False

class pytubekit.configs.ConfigRename

Bases: Config

Rename playlist parameters

rename_new_name = <pytconf.param.Unique object>

rename_playlist_name = <pytconf.param.Unique object>

class pytubekit.configs.ConfigSearch

Bases: Config

Search playlist parameters

search_playlists = []

search_query = <pytconf.param.Unique object>

class pytubekit.configs.ConfigSort

Bases: Config

Sort playlist parameters

sort_key = 'title'

sort_playlist_name = <pytconf.param.Unique object>

class pytubekit.configs.ConfigStatsFilter

Bases: Config

Optional filter for stats command

stats_names = []

class pytubekit.configs.ConfigSubtract

Bases: Config

Subtract parameters

subtract_from = []

subtract_what = []

class pytubekit.configs.ConfigVideo

Bases: Config

Video id to use

id = <pytconf.param.Unique object>

pytubekit.constants module

constants.py

pytubekit.main module

main entry point to the program

pytubekit.main.add_data() → None

pytubekit.main.add_file_to_playlist() → None

pytubekit.main.channels() → None

pytubekit.main.cleanup() → None

pytubekit.main.clear_playlist() → None

pytubekit.main.collect_ids() → None

pytubekit.main.create_playlist() → None

pytubekit.main.delete_playlist() → None

pytubekit.main.diff() → None

pytubekit.main.dump() → None

pytubekit.main.export_csv() → None

pytubekit.main.find_video() → None

pytubekit.main.get_channel_id() → None

pytubekit.main.get_video_ids_from_sources(youtube: Any, playlists: list[str], files: list[str]) → set[str]

pytubekit.main.local_dedup() → None

pytubekit.main.local_diff() → None

pytubekit.main.main()

pytubekit.main.merge() → None

pytubekit.main.overflow() → None

pytubekit.main.playlist() → None

pytubekit.main.print_stats_summary(items: list[tuple[str, int]], label: str) → None

pytubekit.main.rename_playlist() → None

pytubekit.main.search_playlist() → None

pytubekit.main.sort_playlist() → None

pytubekit.main.stats() → None

pytubekit.main.subtract() → None

pytubekit.main.video_info() → None

pytubekit.main.watch_later() → None

pytubekit.static module

version which can be consumed from within the module

pytubekit.util module

util.py

exception pytubekit.util.MutationBudgetError

Bases: Exception

The –max_mutations budget for this run was reached

class pytubekit.util.PagedRequest(f: Any, kwargs: dict[str, Any])

Bases: object

get_all_items() → list[dict[str, Any]]

get_next_page() → tuple[bool, dict[str, Any]]

exception pytubekit.util.QuotaExceededError

Bases: Exception

The YouTube API daily quota is exhausted

class pytubekit.util.RunStats

Bases: object

Per-run counters for API quota accounting

mutations_performed = 0

quota_spent = 0

classmethod reset() → None

pytubekit.util.add_video_to_playlist(youtube: Any, playlist_id: str, video_id: str) → None

pytubekit.util.cleanup_items(youtube: Any, items: list[dict[str, Any]], *, dedup: bool, check_deleted: bool, check_privatized: bool, do_delete: bool) → None

pytubekit.util.create_playlist_request(youtube: Any, playlist_id: str) → PagedRequest

pytubekit.util.create_playlists_request(youtube: Any) → PagedRequest

pytubekit.util.delete_playlist_item_by_id(youtube: Any, playlist_item_id: str) → None

pytubekit.util.get_all_items(youtube: Any) → list[dict[str, Any]]

pytubekit.util.get_all_items_from_playlist_id(youtube: Any, playlist_id: str) → list[dict[str, Any]]

pytubekit.util.get_all_items_from_playlist_ids(youtube: Any, playlist_ids: list[str]) → list[dict[str, Any]]

pytubekit.util.get_error_reasons(e: HttpError) → set[str]

pytubekit.util.get_items_from_playlist_names(youtube: Any, names: list[str]) → list[dict[str, Any]]

pytubekit.util.get_my_playlists_ids(youtube: Any) → list[str]

pytubekit.util.get_playlist_ids_from_names(youtube: Any, playlist_names: list[str]) → list[str]

pytubekit.util.get_playlist_item_count(youtube: Any, playlist_id: str) → int

pytubekit.util.get_playlist_item_ids_from_names(youtube: Any, playlist_names: list[str]) → set[str]

pytubekit.util.get_video_ids_from_playlist_names(youtube: Any, names: list[str]) → set[str]

pytubekit.util.get_video_info(youtube: Any, youtube_id: str) → dict[str, Any]

pytubekit.util.get_video_metadata(video_id: str) → dict[str, Any] | None

pytubekit.util.get_youtube() → Any

pytubekit.util.get_youtube_channels(youtube: Any) → Any

pytubekit.util.get_youtube_playlists(youtube: Any) → Any

pytubekit.util.log_mutation_cost_estimate(logger: Logger, mutations: int) → None

pytubekit.util.log_progress(logger: Logger, current: int, total: int, interval: int = 100) → None

pytubekit.util.move_playlist_item(youtube: Any, playlist_id: str, item: dict[str, Any], position: int) → None

pytubekit.util.perform_mutation(request: Any) → dict[str, Any]

pytubekit.util.pretty_print(data: Any, fp: IO[str] = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>) → None

pytubekit.util.read_all_dump_files(dump_folder: str) → dict[str, list[str]]

pytubekit.util.read_video_ids_from_files(file_paths: list[str]) → set[str]

pytubekit.util.read_video_ids_from_path(path: str) → set[str]

pytubekit.util.retry_execute(request: Any, max_retries: int = 5, cost: int = 1) → dict[str, Any]

pytubekit.youtube module

Module that handles the interaction with the yt_dlp library

References: - https://github.com/yt-dlp/yt-dlp#embedding-yt-dlp

pytubekit.youtube.youtube_dl_download_urls(urls: list[str]) → None

Module contents

Initialize the module