danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

remove old examples

Browse source
This commit is contained in:
Jesse Bannon 2022-10-08 00:39:55 -07:00
parent 69083ae357
commit c56322a413
3 changed files with 1 additions and 124 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
examples/README.md
View file

@ -4,13 +4,4 @@ are the configs I personally use and have incorporated as part of the e2e tests.
Each example has a `config.yaml` and `subscription.yaml`. The config defines
_how_ you format your media, whereas the subscription defines _what_ you
download plus some additional configuring if needed.
Also note that `kodi` examples are applicable for `jellyfin`, `emby`, and
`plex` with the
[XBMC Movies](https://github.com/gboudreau/XBMCnfoMoviesImporter.bundle)
or
[XBMC TV Show](https://github.com/gboudreau/XBMCnfoTVImporter.bundle)
Plex importer. We would like to improve Plex support, please chime in
[here](https://github.com/jmbannon/ytdl-sub/issues/6)
if you have experience with importing custom videos with metadata.
download plus some additional configuring if needed.

87
examples/kodi_tv_shows_config.yaml
View file

@ -1,87 +0,0 @@
# This example shows how to download and format an entire Youtube channel
# to display in Kodi as a TV show. The directory format will look like
#
# /path/to/youtube_tv_shows/My Favorite Youtube Channel
# /Season 2021
# s2021.e0317 - Pattys Day Video-thumb.jpg
# s2021.e0317 - Pattys Day Video.mp4
# s2021.e0317 - Pattys Day Video.nfo
# /Season 2022
# s2022.e1225 - Merry Christmas-thumb.jpg
# s2022.e1225 - Merry Christmas.mp4
# s2022.e1225 - Merry Christmas.nfo
# poster.jpg
# fanart.jpg
# tvshow.nfo
#
# The idea is to use dates as the numeric to represent season and episode
# numbers. Once downloaded, it can immediately be recognized by Kodi.
configuration:
working_directory: '.ytdl-sub-downloads'
presets:
###############################################################################
# FULL ARCHIVE
# This preset will download every single video in a YouTube channel.
yt_channel_as_tv:
# YouTube channels are our source/download strategy
# Use the channel avatar and banner images for Kodi
youtube:
download_strategy: "channel"
channel_avatar_path: "poster.jpg"
channel_banner_path: "fanart.jpg"
# For advanced YTDL users only; any YTDL parameter can be set here.
# To download age-restricted videos, you will need to set your cookie
# file here as a ytdl parameter. For more info, see
# https://ytdl-sub.readthedocs.io/en/latest/faq.html#download-age-restricted-youtube-videos
#
# ytdl_options:
# cookiefile: "path/to/cookie_file.txt
# For each video downloaded, set the file and thumbnail name here.
# We set both with {episode_name}, which is a variable we define in
# the overrides section further below to represent our date-like episode
# naming convention. Using override variables helps reduce copy-paste.
#
# Another field worth mentioning is maintain_download_archive=True. This
# is generally a good thing to enable with channels because it will
# store previously downloaded video ids to tell YTDL not to re-download
# them on a successive invocation.
output_options:
output_directory: "{youtube_tv_shows_directory}/{tv_show_name_sanitized}"
file_name: "{episode_name}.{ext}"
thumbnail_name: "{episode_name}-thumb.jpg"
info_json_name: "{episode_name}.{info_json_ext}"
maintain_download_archive: True
# For each video downloaded, add an episode NFO file for it. We give it
# the same date-like episode name using our {episode_name} variable, and
# populate the NFO with available video metadata that Kodi will recognize.
nfo_tags:
nfo_name: "{episode_name}.nfo"
nfo_root: "episodedetails"
tags:
title: "{title}"
season: "{upload_year}"
episode: "{upload_month}{upload_day_padded}"
plot: "{description}"
year: "{upload_year}"
aired: "{upload_date_standardized}"
# In the output directory, create a tvshow.nfo file. Kodi looks for this
# in the root of the TV show directory to get the TV show (title) name.
output_directory_nfo_tags:
nfo_name: "tvshow.nfo"
nfo_root: "tvshow"
tags:
title: "{tv_show_name}"
plot: "{source_description}"
# Overrides is a section where we can define our own variables, and use them in
# any other section. We define our tv show directory and episode file name here,
# which gets reused above for the video, thumbnail, and NFO file.
overrides:
youtube_tv_shows_directory: "/path/to/youtube_tv_shows"
episode_name: "Season {upload_year}/s{upload_year}.e{upload_month_padded}{upload_day_padded} - {title_sanitized}"

27
examples/kodi_tv_shows_subscriptions.yaml
View file

@ -1,27 +0,0 @@
# This example shows how we can use the `kodi_tv_shows_config.yaml` preset
# to download channels in a few different ways. We will use made-up channels
# in each example.
###############################################################################
# FULL ARCHIVE
#
# Subscription names are defined by you. We will call this one
# john_smith_archive because it will download every single video in
# john_smith's channel.
john_smith_archive:
# We must define a preset to use from our config. The one that downloads the
# entire YouTube channel is called "yt_channel_as_tv", so set that here.
preset: "yt_channel_as_tv"
# Our download strategy was Youtube channels. Define the channel url here
# in our subscription.
youtube:
channel_url: "https://youtube.com/channel/UCsvn_Po0SmunchJYtttWpOxMg"
# Overrides can be defined per-subscription. If you noticed, we used
# {tv_show_name} and {tv_show_name_sanitized} in our "yt_channel_as_tv"
# preset. We intended to reserve that variable to be defined for each
# individual subscription. Each override defined here will create a
# '_sanitized' version that is safe for file systems.
overrides:
tv_show_name: "John /\ Smith"