This commit is contained in:
Sarsoo 2021-06-19 12:01:25 +00:00
parent 07183d8b00
commit f5d263fe0e
26 changed files with 500 additions and 29 deletions

Binary file not shown.

Binary file not shown.

BIN
.doctrees/src/admin.doctree Normal file

Binary file not shown.

View File

@ -7,6 +7,7 @@ Music Tools
Py <src/music>
Js <src/MusicTools>
Admin Script <src/admin>
All Modules <src/modules>
`Music Tools <https://music.sarsoo.xyz>`_

View File

@ -0,0 +1,8 @@
admin script
==================
.. automodule:: admin
:members:
:undoc-members:
:show-inheritance:

View File

@ -63,15 +63,24 @@
<li><a href="src/music.model.html#music.model.playlist.Playlist.add_last_month">add_last_month (music.model.playlist.Playlist attribute)</a>
</li>
<li><a href="src/music.model.html#music.model.playlist.Playlist.add_this_month">add_this_month (music.model.playlist.Playlist attribute)</a>
</li>
<li>
admin
<ul>
<li><a href="src/admin.html#module-admin">module</a>
</li>
</ul></li>
<li><a href="src/admin.html#admin.Admin">Admin (class in admin)</a>
</li>
<li><a href="src/MusicTools.Admin.html#Admin">Admin() (class)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/MusicTools.Admin.html#Admin.handleChange">Admin.handleChange() (Admin method)</a>
</li>
<li><a href="src/music.api.html#music.api.decorators.admin_required">admin_required() (in module music.api.decorators)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/music.model.html#music.model.tag.Tag.albums">albums (music.model.tag.Tag attribute)</a>
</li>
<li><a href="src/music.api.html#music.api.api.all_playlists_route">all_playlists_route() (in module music.api.api)</a>
@ -156,9 +165,13 @@
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/admin.html#admin.Admin.compile_frontend">compile_frontend() (admin.Admin method)</a>
</li>
<li><a href="src/music.model.html#music.model.config.Config">Config (class in music.model.config)</a>
</li>
<li><a href="src/music.model.html#music.model.config.Config.Meta">Config.Meta (class in music.model.config)</a>
</li>
<li><a href="src/admin.html#admin.Admin.copy_main_file">copy_main_file() (admin.Admin method)</a>
</li>
<li><a href="src/music.model.html#music.model.tag.Tag.count">count (music.model.tag.Tag attribute)</a>
</li>
@ -190,17 +203,57 @@
</li>
<li><a href="src/music.auth.html#music.auth.auth.deauth">deauth() (in module music.auth.auth)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/MusicTools.Settings.html#DeAuthButton">DeAuthButton() (built-in function)</a>
</li>
<li><a href="src/music.model.html#music.model.playlist.Sort.default">default (music.model.playlist.Sort attribute)</a>
</li>
<li><a href="src/music.api.html#music.api.tag.delete_tag">delete_tag() (in module music.api.tag)</a>
</li>
<li><a href="src/admin.html#admin.Admin.deploy_function">deploy_function() (admin.Admin method)</a>
</li>
<li><a href="src/music.model.html#music.model.playlist.Playlist.description_overwrite">description_overwrite (music.model.playlist.Playlist attribute)</a>
</li>
<li><a href="src/music.model.html#music.model.playlist.Playlist.description_suffix">description_suffix (music.model.playlist.Playlist attribute)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_app">do_app() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_cron_functions">do_cron_functions() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_docs">do_docs() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_exit">do_exit() (admin.Admin method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/admin.html#admin.Admin.do_main_group">do_main_group() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_playlist">do_playlist() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_playlist_cron">do_playlist_cron() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_playlist_stats_cron">do_playlist_stats_cron() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_prepare_local_stage">do_prepare_local_stage() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_pydepend">do_pydepend() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_rename">do_rename() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_run">do_run() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_sass">do_sass() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_set_project">do_set_project() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_tag">do_tag() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_tags_cron">do_tags_cron() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_test">do_test() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.do_watchsass">do_watchsass() (admin.Admin method)</a>
</li>
<li><a href="src/admin.html#admin.docs">docs() (in module admin)</a>
</li>
</ul></td>
</tr></table>
@ -241,6 +294,8 @@
<li><a href="src/MusicTools.Playlist.html#Edit.makeNetworkUpdate">Edit.makeNetworkUpdate() (Edit method)</a>
</li>
<li><a href="src/music.model.html#music.model.user.User.email">email (music.model.user.User attribute)</a>
</li>
<li><a href="src/admin.html#admin.Admin.export_filtered_dependencies">export_filtered_dependencies() (admin.Admin method)</a>
</li>
</ul></td>
</tr></table>
@ -248,10 +303,14 @@
<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/MusicTools.Admin.html#Functions">Functions() (class)</a>
<li><a href="src/admin.html#admin.folders_to_ignore">folders_to_ignore (in module admin)</a>
</li>
<li><a href="src/admin.html#admin.Admin.function_deploy">function_deploy() (admin.Admin method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/MusicTools.Admin.html#Functions">Functions() (class)</a>
</li>
<li><a href="src/MusicTools.Admin.html#Functions.runAllUsers">Functions.runAllUsers() (Functions method)</a>
</li>
<li><a href="src/MusicTools.Admin.html#Functions.runStats">Functions.runStats() (Functions method)</a>
@ -297,6 +356,8 @@
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/music.html#music.init_log">init_log() (in module music)</a>
</li>
<li><a href="src/admin.html#admin.Admin.intro">intro (admin.Admin attribute)</a>
</li>
<li><a href="src/music.api.html#music.api.decorators.is_basic_authed">is_basic_authed() (in module music.api.decorators)</a>
</li>
@ -347,6 +408,8 @@
<li><a href="src/music.model.html#music.model.user.User.lastfm_username">lastfm_username (music.model.user.User attribute)</a>
</li>
<li><a href="src/music.api.html#music.api.decorators.lastfm_username_required">lastfm_username_required() (in module music.api.decorators)</a>
</li>
<li><a href="src/admin.html#admin.Admin.locals">locals (admin.Admin attribute)</a>
</li>
<li><a href="src/MusicTools.Admin.html#Lock">Lock() (class)</a>
</li>
@ -374,6 +437,8 @@
module
<ul>
<li><a href="src/admin.html#module-admin">admin</a>
</li>
<li><a href="src/music.html#module-music">music</a>
</li>
<li><a href="src/music.api.html#module-music.api">music.api</a>
@ -489,6 +554,8 @@
<li><a href="src/music.api.html#module-music.api.spotfm">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
music.api.spotify
@ -496,8 +563,6 @@
<li><a href="src/music.api.html#module-music.api.spotify">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
music.api.tag
@ -724,10 +789,10 @@
</li>
<li><a href="src/music.api.html#music.api.spotfm.playlist_refresh">playlist_refresh() (in module music.api.spotfm)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/MusicTools.Playlist.html#PlaylistCard">PlaylistCard() (class)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/MusicTools.Playlist.html#PlaylistGrid">PlaylistGrid() (class)</a>
</li>
<li><a href="src/MusicTools.Playlist.html#PlaylistRouter.View">PlaylistRouter.View() (class)</a>
@ -751,6 +816,8 @@
<li><a href="src/music.db.html#music.db.part_generator.PartGenerator.process_reference_by_name">process_reference_by_name() (music.db.part_generator.PartGenerator method)</a>
</li>
<li><a href="src/music.db.html#music.db.part_generator.PartGenerator.process_reference_by_reference">process_reference_by_reference() (music.db.part_generator.PartGenerator method)</a>
</li>
<li><a href="src/admin.html#admin.Admin.prompt">prompt (admin.Admin attribute)</a>
</li>
<li><a href="src/music.model.html#music.model.tag.Tag.proportion">proportion (music.model.tag.Tag attribute)</a>
</li>
@ -802,6 +869,8 @@
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/admin.html#admin.run">run() (in module admin)</a>
</li>
<li><a href="src/music.api.html#music.api.api.run_playlist">run_playlist() (in module music.api.api)</a>
</li>
<li><a href="src/music.api.html#music.api.spotfm.run_playlist_album_task">run_playlist_album_task() (in module music.api.spotfm)</a>
@ -920,10 +989,10 @@
</li>
<li><a href="src/MusicTools.Tag.html#TagView.handleCheckChange">TagView.handleCheckChange() (TagView method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/MusicTools.Tag.html#TagView.handleInputChange">TagView.handleInputChange() (TagView method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="src/MusicTools.Tag.html#TagView.handleRemoveObj">TagView.handleRemoveObj() (TagView method)</a>
</li>
<li><a href="src/MusicTools.Tag.html#TagView.handleRun">TagView.handleRun() (TagView method)</a>
@ -935,6 +1004,8 @@
<li><a href="src/MusicTools.Admin.html#Tasks.getTasks">Tasks.getTasks() (Tasks method)</a>
</li>
<li><a href="src/MusicTools.Admin.html#TaskType">TaskType() (built-in function)</a>
</li>
<li><a href="src/admin.html#admin.test">test() (in module admin)</a>
</li>
<li><a href="src/music.model.html#music.model.tag.Tag.time_objects">time_objects (music.model.tag.Tag attribute)</a>
</li>
@ -1041,6 +1112,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="src/music.html">Py</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/admin.html">Admin Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/modules.html">All Modules</a></li>
</ul>

View File

@ -55,6 +55,7 @@
<li class="toctree-l2"><a class="reference internal" href="src/MusicTools.Settings.html">Settings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="src/admin.html">Admin Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/modules.html">All Modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="src/music.html">Flask Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/MusicTools.html">React Frontend</a></li>
@ -99,6 +100,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="src/music.html">Py</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/admin.html">Admin Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/modules.html">All Modules</a></li>
</ul>

Binary file not shown.

View File

@ -37,11 +37,20 @@
<h1>Python Module Index</h1>
<div class="modindex-jumpbox">
<a href="#cap-a"><strong>a</strong></a> |
<a href="#cap-m"><strong>m</strong></a>
</div>
<table class="indextable modindextable">
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-a"><td></td><td>
<strong>a</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="src/admin.html#module-admin"><code class="xref">admin</code></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-m"><td></td><td>
<strong>m</strong></td><td></td></tr>
<tr>
@ -213,6 +222,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="src/music.html">Py</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/admin.html">Admin Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/modules.html">All Modules</a></li>
</ul>

View File

@ -78,6 +78,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="src/music.html">Py</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/admin.html">Admin Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/modules.html">All Modules</a></li>
</ul>

File diff suppressed because one or more lines are too long

View File

@ -200,7 +200,12 @@
<li class="toctree-l2"><a class="reference internal" href="MusicTools.Settings.html">Settings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">

View File

@ -107,7 +107,12 @@
<li class="toctree-l2"><a class="reference internal" href="MusicTools.Settings.html">Settings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">

View File

@ -483,7 +483,12 @@
<li class="toctree-l2"><a class="reference internal" href="MusicTools.Settings.html">Settings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">

View File

@ -15,7 +15,7 @@
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Music Tools Modules" href="modules.html" />
<link rel="next" title="admin script" href="admin.html" />
<link rel="prev" title="Admin" href="MusicTools.Admin.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@ -237,7 +237,12 @@
<li class="toctree-l2 current"><a class="current reference internal" href="#">Settings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">
@ -246,7 +251,7 @@
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="MusicTools.html">React Frontend</a><ul>
<li>Previous: <a href="MusicTools.Admin.html" title="previous chapter">Admin</a></li>
<li>Next: <a href="modules.html" title="next chapter">Music Tools Modules</a></li>
<li>Next: <a href="admin.html" title="next chapter">admin script</a></li>
</ul></li>
</ul></li>
</ul>

View File

@ -305,7 +305,12 @@
<li class="toctree-l2"><a class="reference internal" href="MusicTools.Settings.html">Settings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">

View File

@ -140,7 +140,12 @@
<li class="toctree-l2"><a class="reference internal" href="MusicTools.Settings.html">Settings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">

311
src/admin.html Normal file
View File

@ -0,0 +1,311 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<title>admin script &#8212; Music Tools documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Music Tools Modules" href="modules.html" />
<link rel="prev" title="Settings" href="MusicTools.Settings.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-admin">
<span id="admin-script"></span><h1>admin script<a class="headerlink" href="#module-admin" title="Permalink to this headline"></a></h1>
<dl class="py class">
<dt id="admin.Admin">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">admin.</span></code><code class="sig-name descname"><span class="pre">Admin</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">completekey</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'tab'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">cmd.Cmd</span></code></p>
<dl class="py method">
<dt id="admin.Admin.compile_frontend">
<code class="sig-name descname"><span class="pre">compile_frontend</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.compile_frontend" title="Permalink to this definition"></a></dt>
<dd><p>Compile sass to css and run npm build task</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.copy_main_file">
<code class="sig-name descname"><span class="pre">copy_main_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.copy_main_file" title="Permalink to this definition"></a></dt>
<dd><p>Copy main.{path}.py file corresponding to Python build stage</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.deploy_function">
<code class="sig-name descname"><span class="pre">deploy_function</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">60</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'europe-west2'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.deploy_function" title="Permalink to this definition"></a></dt>
<dd><p>Deploy function with required environment variables</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_app">
<code class="sig-name descname"><span class="pre">do_app</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_app" title="Permalink to this definition"></a></dt>
<dd><p>Compile front-end and deploy to App Engine</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_cron_functions">
<code class="sig-name descname"><span class="pre">do_cron_functions</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_cron_functions" title="Permalink to this definition"></a></dt>
<dd><p>Deploy background functions including cron job scheduling for update actions (run_all_playlists, run_all_playlist_stats, run_all_tags)</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_docs">
<code class="sig-name descname"><span class="pre">do_docs</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_docs" title="Permalink to this definition"></a></dt>
<dd><p>Compile documentation using sphinx</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_exit">
<code class="sig-name descname"><span class="pre">do_exit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_exit" title="Permalink to this definition"></a></dt>
<dd><p>Exit script</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_main_group">
<code class="sig-name descname"><span class="pre">do_main_group</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_main_group" title="Permalink to this definition"></a></dt>
<dd><p>Compile front-end and deploy to App Engine. Deploy primary functions (run_user_playlist, update_tag)</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_playlist">
<code class="sig-name descname"><span class="pre">do_playlist</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_playlist" title="Permalink to this definition"></a></dt>
<dd><p>Deploy run_user_playlist function</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_playlist_cron">
<code class="sig-name descname"><span class="pre">do_playlist_cron</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_playlist_cron" title="Permalink to this definition"></a></dt>
<dd><p>Deploy run_all_playlists function</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_playlist_stats_cron">
<code class="sig-name descname"><span class="pre">do_playlist_stats_cron</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_playlist_stats_cron" title="Permalink to this definition"></a></dt>
<dd><p>Deploy run_all_playlist_stats function</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_prepare_local_stage">
<code class="sig-name descname"><span class="pre">do_prepare_local_stage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_prepare_local_stage" title="Permalink to this definition"></a></dt>
<dd><p>Prepare local working directory for deployment using static sarsoolib injections</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_pydepend">
<code class="sig-name descname"><span class="pre">do_pydepend</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_pydepend" title="Permalink to this definition"></a></dt>
<dd><p>Generate and export requirements.txt from Poetry manifest</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_rename">
<code class="sig-name descname"><span class="pre">do_rename</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_rename" title="Permalink to this definition"></a></dt>
<dd><p>Rename playlist in firestore</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_run">
<code class="sig-name descname"><span class="pre">do_run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_run" title="Permalink to this definition"></a></dt>
<dd><p>Run Flask app</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_sass">
<code class="sig-name descname"><span class="pre">do_sass</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_sass" title="Permalink to this definition"></a></dt>
<dd><p>Compile sass to css</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_set_project">
<code class="sig-name descname"><span class="pre">do_set_project</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_set_project" title="Permalink to this definition"></a></dt>
<dd><p>Set project setting in gcloud console</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_tag">
<code class="sig-name descname"><span class="pre">do_tag</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_tag" title="Permalink to this definition"></a></dt>
<dd><p>Deploy update_tag function</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_tags_cron">
<code class="sig-name descname"><span class="pre">do_tags_cron</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_tags_cron" title="Permalink to this definition"></a></dt>
<dd><p>Deploy run_all_tags function</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_test">
<code class="sig-name descname"><span class="pre">do_test</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_test" title="Permalink to this definition"></a></dt>
<dd><p>Run Python unit tests</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.do_watchsass">
<code class="sig-name descname"><span class="pre">do_watchsass</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.do_watchsass" title="Permalink to this definition"></a></dt>
<dd><p>Run sass compiler with watch argument to begin watching source folder for changes</p>
</dd></dl>
<dl class="py method">
<dt id="admin.Admin.export_filtered_dependencies">
<code class="sig-name descname"><span class="pre">export_filtered_dependencies</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.export_filtered_dependencies" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="admin.Admin.function_deploy">
<code class="sig-name descname"><span class="pre">function_deploy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">main</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#admin.Admin.function_deploy" title="Permalink to this definition"></a></dt>
<dd><p>Deploy Cloud Function, copy main file and initiate gcloud command</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>main</strong> (<em>str</em>) main path</p></li>
<li><p><strong>function_id</strong> (<em>str</em>) function id to deploy to</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="admin.Admin.intro">
<code class="sig-name descname"><span class="pre">intro</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Music</span> <span class="pre">Tools</span> <span class="pre">Admin...</span> <span class="pre">?</span> <span class="pre">for</span> <span class="pre">help'</span></em><a class="headerlink" href="#admin.Admin.intro" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="admin.Admin.locals">
<code class="sig-name descname"><span class="pre">locals</span></code><em class="property"> <span class="pre">=</span> <span class="pre">['spotframework',</span> <span class="pre">'fmframework',</span> <span class="pre">'spotfm']</span></em><a class="headerlink" href="#admin.Admin.locals" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="admin.Admin.prompt">
<code class="sig-name descname"><span class="pre">prompt</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'&gt;</span> <span class="pre">'</span></em><a class="headerlink" href="#admin.Admin.prompt" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt id="admin.docs">
<code class="sig-prename descclassname"><span class="pre">admin.</span></code><code class="sig-name descname"><span class="pre">docs</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#admin.docs" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt id="admin.folders_to_ignore">
<code class="sig-prename descclassname"><span class="pre">admin.</span></code><code class="sig-name descname"><span class="pre">folders_to_ignore</span></code><em class="property"> <span class="pre">=</span> <span class="pre">['venv',</span> <span class="pre">'docs',</span> <span class="pre">'.git',</span> <span class="pre">'.idea',</span> <span class="pre">'node_modules']</span></em><a class="headerlink" href="#admin.folders_to_ignore" title="Permalink to this definition"></a></dt>
<dd><p>COMPONENTS:</p>
<ul>
<li><p>App Engine</p></li>
<li><dl>
<dt>Cloud Functions:</dt><dd><p>run_user_playlist
update_tag</p>
<p>run_all_playlists
run_all_playlist_stats
run_all_tags</p>
</dd>
</dl>
</li>
</ul>
</dd></dl>
<dl class="py function">
<dt id="admin.run">
<code class="sig-prename descclassname"><span class="pre">admin.</span></code><code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#admin.run" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="admin.test">
<code class="sig-prename descclassname"><span class="pre">admin.</span></code><code class="sig-name descname"><span class="pre">test</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#admin.test" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">Music Tools</a></h1>
<h3>Navigation</h3>
<p><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="music.html">Py</a></li>
<li class="toctree-l1"><a class="reference internal" href="MusicTools.html">Js</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Admin Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li>Previous: <a href="MusicTools.Settings.html" title="previous chapter">Settings</a></li>
<li>Next: <a href="modules.html" title="next chapter">Music Tools Modules</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2021, Sarsoo.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="../_sources/src/admin.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

View File

@ -15,7 +15,7 @@
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="prev" title="Settings" href="MusicTools.Settings.html" />
<link rel="prev" title="admin script" href="admin.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@ -147,6 +147,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="music.html">Py</a></li>
<li class="toctree-l1"><a class="reference internal" href="MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">All Modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
@ -158,7 +159,7 @@
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li>Previous: <a href="MusicTools.Settings.html" title="previous chapter">Settings</a></li>
<li>Previous: <a href="admin.html" title="previous chapter">admin script</a></li>
</ul></li>
</ul>
</div>

View File

@ -342,7 +342,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">

View File

@ -113,7 +113,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">

View File

@ -200,7 +200,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">

View File

@ -187,7 +187,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">

View File

@ -140,7 +140,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Flask Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">

View File

@ -561,7 +561,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">

View File

@ -155,7 +155,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="MusicTools.html">Js</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">All Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="music.html">Flask Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="MusicTools.html">React Frontend</a></li>
</ul>
</li>
</ul>
<div class="relations">