144 lines
No EOL
7.9 KiB
HTML
144 lines
No EOL
7.9 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.cli 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.cli package</a><ul>
|
||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.cli.download_args_parser">ytdl_subscribe.cli.download_args_parser module</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.cli.main_args_parser">ytdl_subscribe.cli.main_args_parser module</a></li>
|
||
<li><a class="reference internal" href="#module-ytdl_subscribe.cli">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.cli package</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="../_sources/source/ytdl_subscribe.cli.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-cli-package">
|
||
<h1>ytdl_subscribe.cli package<a class="headerlink" href="#ytdl-subscribe-cli-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.cli.download_args_parser">
|
||
<span id="ytdl-subscribe-cli-download-args-parser-module"></span><h2>ytdl_subscribe.cli.download_args_parser module<a class="headerlink" href="#module-ytdl_subscribe.cli.download_args_parser" title="Permalink to this headline"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.cli.download_args_parser.DownloadArgsParser">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ytdl_subscribe.cli.download_args_parser.</span></span><span class="sig-name descname"><span class="pre">DownloadArgsParser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extra_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ytdl_subscribe.cli.download_args_parser.DownloadArgsParser" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>‘Extra’ arguments can be given to <cite>ytdl-sub dl</cite> which are meant to represent fields
|
||
in a subscription yaml. This class will convert those extra args into a dict that can be
|
||
passed in to instantiate a
|
||
<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"><code class="xref py py-class docutils literal notranslate"><span class="pre">PresetValidator</span></code></a></p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.cli.download_args_parser.DownloadArgsParser.get_args_hash">
|
||
<span class="sig-name descname"><span class="pre">get_args_hash</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#ytdl_subscribe.cli.download_args_parser.DownloadArgsParser.get_args_hash" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Hash of the arguments provided</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="ytdl_subscribe.cli.download_args_parser.DownloadArgsParser.to_subscription_dict">
|
||
<span class="sig-name descname"><span class="pre">to_subscription_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#ytdl_subscribe.cli.download_args_parser.DownloadArgsParser.to_subscription_dict" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Converts the extra arguments into a dict equivalent to a subscription yaml.
|
||
:return: dict containing argument names and values</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-ytdl_subscribe.cli.main_args_parser">
|
||
<span id="ytdl-subscribe-cli-main-args-parser-module"></span><h2>ytdl_subscribe.cli.main_args_parser module<a class="headerlink" href="#module-ytdl_subscribe.cli.main_args_parser" title="Permalink to this headline"></a></h2>
|
||
</section>
|
||
<section id="module-ytdl_subscribe.cli">
|
||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-ytdl_subscribe.cli" 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> |