248 lines
No EOL
30 KiB
HTML
248 lines
No EOL
30 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>ytdl_subscribe.subscriptions package — ytdl-subscribe documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
<a href="../index.html" class="icon icon-home"> ytdl-subscribe
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<!-- Local TOC -->
|
||
<div class="local-toc"><ul>
|
||
<li><a class="reference internal" href="#">ytdl_subscribe.subscriptions package</a><ul>
|
||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.subscriptions.soundcloud">ytdl_subscribe.subscriptions.soundcloud module</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.subscriptions.subscription">ytdl_subscribe.subscriptions.subscription module</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.subscriptions.youtube">ytdl_subscribe.subscriptions.youtube module</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.subscriptions">Module contents</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">ytdl-subscribe</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home"></a> »</li>
|
||
<li>ytdl_subscribe.subscriptions package</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="../_sources/source/ytdl_subscribe.subscriptions.rst.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="ytdl-subscribe-subscriptions-package">
|
||
<h1>ytdl_subscribe.subscriptions package<a class="headerlink" href="#ytdl-subscribe-subscriptions-package" title="Permalink to this headline"></a></h1>
|
||
<section id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
|
||
</section>
|
||
<section id="module-ytdl_subscribe.subscriptions.soundcloud">
|
||
<span id="ytdl-subscribe-subscriptions-soundcloud-module"></span><h2>ytdl_subscribe.subscriptions.soundcloud module<a class="headerlink" href="#module-ytdl_subscribe.subscriptions.soundcloud" title="Permalink to this headline"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.soundcloud.SoundcloudAlbumsAndSinglesSubscription">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.subscriptions.soundcloud.</span></span><span class="sig-name descname"><span class="pre">SoundcloudAlbumsAndSinglesSubscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ytdl_subscribe.validators.config.config_options.html#ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator" title="ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator"><span class="pre">ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">preset_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ytdl_subscribe.validators.config.html#ytdl_subscribe.validators.config.preset_validator.PresetValidator" title="ytdl_subscribe.validators.config.preset_validator.PresetValidator"><span class="pre">ytdl_subscribe.validators.config.preset_validator.PresetValidator</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.subscriptions.soundcloud.SoundcloudAlbumsAndSinglesSubscription" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.subscriptions.subscription.Subscription" title="ytdl_subscribe.subscriptions.subscription.Subscription"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.subscriptions.subscription.Subscription</span></code></a>[<a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html#ytdl_subscribe.validators.config.source_options.soundcloud_validators.SoundcloudAlbumsAndSinglesSourceValidator" title="ytdl_subscribe.validators.config.source_options.soundcloud_validators.SoundcloudAlbumsAndSinglesSourceValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.config.source_options.soundcloud_validators.SoundcloudAlbumsAndSinglesSourceValidator</span></code></a>, <a class="reference internal" href="ytdl_subscribe.entries.html#ytdl_subscribe.entries.soundcloud.SoundcloudTrack" title="ytdl_subscribe.entries.soundcloud.SoundcloudTrack"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.entries.soundcloud.SoundcloudTrack</span></code></a>]</p>
|
||
<p>Soundcloud subscription to download albums and tracks as singles.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-ytdl_subscribe.subscriptions.subscription">
|
||
<span id="ytdl-subscribe-subscriptions-subscription-module"></span><h2>ytdl_subscribe.subscriptions.subscription module<a class="headerlink" href="#module-ytdl_subscribe.subscriptions.subscription" title="Permalink to this headline"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.subscription.Subscription">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.subscriptions.subscription.</span></span><span class="sig-name descname"><span class="pre">Subscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ytdl_subscribe.validators.config.config_options.html#ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator" title="ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator"><span class="pre">ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">preset_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ytdl_subscribe.validators.config.html#ytdl_subscribe.validators.config.preset_validator.PresetValidator" title="ytdl_subscribe.validators.config.preset_validator.PresetValidator"><span class="pre">ytdl_subscribe.validators.config.preset_validator.PresetValidator</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.subscriptions.subscription.Subscription" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Generic</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">ytdl_subscribe.subscriptions.subscription.SourceT</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">ytdl_subscribe.subscriptions.subscription.EntryT</span></code>], <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||
<p>Subscription classes are the ‘controllers’ that perform…</p>
|
||
<ul class="simple">
|
||
<li><p>Downloading via ytdlp</p></li>
|
||
<li><p>Adding metadata</p></li>
|
||
<li><p>Placing files in the output directory</p></li>
|
||
</ul>
|
||
<p>while configuring each step with provided configs. Child classes are expected to
|
||
provide SourceValidator (SourceT), which defines the source and its configurable options.
|
||
In addition, they should provide in the init an Entry type (EntryT), which is the entry that
|
||
will be returned after downloading.</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.subscription.Subscription.download">
|
||
<span class="sig-name descname"><span class="pre">download</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.subscriptions.subscription.Subscription.download" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Performs the subscription download.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.subscription.Subscription.entry_type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entry_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">ytdl_subscribe.subscriptions.subscription.EntryT</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ytdl_subscribe.subscriptions.subscription.Subscription.entry_type" title="Permalink to this definition"></a></dt>
|
||
<dd><p>The Entry type this subscription uses to represent downloaded media</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>return</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.subscription.Subscription.get_downloader">
|
||
<span class="sig-name descname"><span class="pre">get_downloader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">downloader_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">ytdl_subscribe.subscriptions.subscription.DownloaderT</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_ytdl_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ytdl_subscribe.subscriptions.subscription.DownloaderT</span></span></span><a class="headerlink" href="#ytdl_subscribe.subscriptions.subscription.Subscription.get_downloader" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the downloader that will be used to download media for this subscription</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.subscription.Subscription.metadata_options">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">metadata_options</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ytdl_subscribe.validators.config.metadata_options.html#ytdl_subscribe.validators.config.metadata_options.metadata_options_validator.MetadataOptionsValidator" title="ytdl_subscribe.validators.config.metadata_options.metadata_options_validator.MetadataOptionsValidator"><span class="pre">ytdl_subscribe.validators.config.metadata_options.metadata_options_validator.MetadataOptionsValidator</span></a></em><a class="headerlink" href="#ytdl_subscribe.subscriptions.subscription.Subscription.metadata_options" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the metadata options defined for this subscription</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.subscription.Subscription.output_directory">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">output_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ytdl_subscribe.subscriptions.subscription.Subscription.output_directory" title="Permalink to this definition"></a></dt>
|
||
<dd><p>The formatted output directory</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>return</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.subscription.Subscription.output_options">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">output_options</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ytdl_subscribe.validators.config.output_options.html#ytdl_subscribe.validators.config.output_options.output_options_validator.OutputOptionsValidator" title="ytdl_subscribe.validators.config.output_options.output_options_validator.OutputOptionsValidator"><span class="pre">ytdl_subscribe.validators.config.output_options.output_options_validator.OutputOptionsValidator</span></a></em><a class="headerlink" href="#ytdl_subscribe.subscriptions.subscription.Subscription.output_options" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the output options defined for this subscription</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.subscription.Subscription.overrides">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">overrides</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="ytdl_subscribe.validators.config.overrides.html#ytdl_subscribe.validators.config.overrides.overrides_validator.OverridesValidator" title="ytdl_subscribe.validators.config.overrides.overrides_validator.OverridesValidator"><span class="pre">ytdl_subscribe.validators.config.overrides.overrides_validator.OverridesValidator</span></a></em><a class="headerlink" href="#ytdl_subscribe.subscriptions.subscription.Subscription.overrides" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the overrides defined for this subscription</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.subscription.Subscription.post_process_entry">
|
||
<span class="sig-name descname"><span class="pre">post_process_entry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ytdl_subscribe.entries.html#ytdl_subscribe.entries.entry.Entry" title="ytdl_subscribe.entries.entry.Entry"><span class="pre">ytdl_subscribe.entries.entry.Entry</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#ytdl_subscribe.subscriptions.subscription.Subscription.post_process_entry" title="Permalink to this definition"></a></dt>
|
||
<dd><p>After downloading an entry to the working directory, perform all post-processing, which
|
||
includes:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><p>Adding metadata to the entry file itself (music tags)</p></li>
|
||
<li><p>Moving the entry file + thumbnail to the output directory with its formatted name</p></li>
|
||
<li><p>Creating new metadata files (NFO) to reside alongside the entry files</p></li>
|
||
</ul>
|
||
</div></blockquote>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>entry</strong> – The entry to post-process</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.subscription.Subscription.source_options">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">source_options</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ytdl_subscribe.subscriptions.subscription.SourceT</span></em><a class="headerlink" href="#ytdl_subscribe.subscriptions.subscription.Subscription.source_options" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the source options defined for this subscription</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.subscription.Subscription.working_directory">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">working_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ytdl_subscribe.subscriptions.subscription.Subscription.working_directory" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Returns the directory that the downloader saves files to</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-ytdl_subscribe.subscriptions.youtube">
|
||
<span id="ytdl-subscribe-subscriptions-youtube-module"></span><h2>ytdl_subscribe.subscriptions.youtube module<a class="headerlink" href="#module-ytdl_subscribe.subscriptions.youtube" title="Permalink to this headline"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.youtube.YoutubeChannelSubscription">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.subscriptions.youtube.</span></span><span class="sig-name descname"><span class="pre">YoutubeChannelSubscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ytdl_subscribe.validators.config.config_options.html#ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator" title="ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator"><span class="pre">ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">preset_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ytdl_subscribe.validators.config.html#ytdl_subscribe.validators.config.preset_validator.PresetValidator" title="ytdl_subscribe.validators.config.preset_validator.PresetValidator"><span class="pre">ytdl_subscribe.validators.config.preset_validator.PresetValidator</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.subscriptions.youtube.YoutubeChannelSubscription" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.subscriptions.subscription.Subscription" title="ytdl_subscribe.subscriptions.subscription.Subscription"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.subscriptions.subscription.Subscription</span></code></a>[<a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html#ytdl_subscribe.validators.config.source_options.youtube_validators.YoutubeChannelSourceValidator" title="ytdl_subscribe.validators.config.source_options.youtube_validators.YoutubeChannelSourceValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.config.source_options.youtube_validators.YoutubeChannelSourceValidator</span></code></a>, <a class="reference internal" href="ytdl_subscribe.entries.html#ytdl_subscribe.entries.youtube.YoutubeVideo" title="ytdl_subscribe.entries.youtube.YoutubeVideo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.entries.youtube.YoutubeVideo</span></code></a>]</p>
|
||
<p>Youtube subscription to download videos from a channel</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.youtube.YoutubePlaylistSubscription">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.subscriptions.youtube.</span></span><span class="sig-name descname"><span class="pre">YoutubePlaylistSubscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ytdl_subscribe.validators.config.config_options.html#ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator" title="ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator"><span class="pre">ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">preset_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ytdl_subscribe.validators.config.html#ytdl_subscribe.validators.config.preset_validator.PresetValidator" title="ytdl_subscribe.validators.config.preset_validator.PresetValidator"><span class="pre">ytdl_subscribe.validators.config.preset_validator.PresetValidator</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.subscriptions.youtube.YoutubePlaylistSubscription" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.subscriptions.subscription.Subscription" title="ytdl_subscribe.subscriptions.subscription.Subscription"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.subscriptions.subscription.Subscription</span></code></a>[<a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html#ytdl_subscribe.validators.config.source_options.youtube_validators.YoutubePlaylistSourceValidator" title="ytdl_subscribe.validators.config.source_options.youtube_validators.YoutubePlaylistSourceValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.config.source_options.youtube_validators.YoutubePlaylistSourceValidator</span></code></a>, <a class="reference internal" href="ytdl_subscribe.entries.html#ytdl_subscribe.entries.youtube.YoutubeVideo" title="ytdl_subscribe.entries.youtube.YoutubeVideo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.entries.youtube.YoutubeVideo</span></code></a>]</p>
|
||
<p>Youtube subscription to download videos from a playlist</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.subscriptions.youtube.YoutubeVideoSubscription">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.subscriptions.youtube.</span></span><span class="sig-name descname"><span class="pre">YoutubeVideoSubscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ytdl_subscribe.validators.config.config_options.html#ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator" title="ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator"><span class="pre">ytdl_subscribe.validators.config.config_options.config_options_validator.ConfigOptionsValidator</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">preset_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="ytdl_subscribe.validators.config.html#ytdl_subscribe.validators.config.preset_validator.PresetValidator" title="ytdl_subscribe.validators.config.preset_validator.PresetValidator"><span class="pre">ytdl_subscribe.validators.config.preset_validator.PresetValidator</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.subscriptions.youtube.YoutubeVideoSubscription" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#ytdl_subscribe.subscriptions.subscription.Subscription" title="ytdl_subscribe.subscriptions.subscription.Subscription"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.subscriptions.subscription.Subscription</span></code></a>[<a class="reference internal" href="ytdl_subscribe.validators.config.source_options.html#ytdl_subscribe.validators.config.source_options.youtube_validators.YoutubeVideoSourceValidator" title="ytdl_subscribe.validators.config.source_options.youtube_validators.YoutubeVideoSourceValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.validators.config.source_options.youtube_validators.YoutubeVideoSourceValidator</span></code></a>, <a class="reference internal" href="ytdl_subscribe.entries.html#ytdl_subscribe.entries.youtube.YoutubeVideo" title="ytdl_subscribe.entries.youtube.YoutubeVideo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ytdl_subscribe.entries.youtube.YoutubeVideo</span></code></a>]</p>
|
||
<p>Youtube subscription to download a single video</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-ytdl_subscribe.subscriptions">
|
||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-ytdl_subscribe.subscriptions" title="Permalink to this headline"></a></h2>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2022, Jesse Bannon.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |