2021-03-23 22:46:23 +00:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
2021-04-04 19:52:28 +01:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.17: http://docutils.sourceforge.net/" / >
2021-03-24 10:15:52 +00:00
< title > music — Music Tools documentation< / title >
2021-03-23 22:46:23 +00:00
< 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" / >
2021-03-24 10:15:52 +00:00
< link rel = "next" title = "music.api" href = "music.api.html" / >
2021-03-23 22:46:23 +00:00
< link rel = "prev" title = "music" href = "modules.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" >
2021-04-04 19:52:28 +01:00
< section id = "music" >
2021-03-24 10:15:52 +00:00
< h1 > music< a class = "headerlink" href = "#music" title = "Permalink to this headline" > ¶< / a > < / h1 >
2021-04-04 19:52:28 +01:00
< section id = "subpackages" >
2021-03-23 22:46:23 +00:00
< h2 > Subpackages< a class = "headerlink" href = "#subpackages" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "toctree-wrapper compound" >
< ul >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "music.api.html" > music.api< / a > < ul >
2021-03-23 22:46:23 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "music.api.html#module-music.api" > Module contents< / a > < / li >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "music.api.html#module-music.api.admin" > api.admin< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.api.html#module-music.api.api" > api.api< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.api.html#module-music.api.decorators" > api.decorators< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.api.html#module-music.api.fm" > api.fm< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.api.html#module-music.api.player" > api.player< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.api.html#module-music.api.spotfm" > api.spotfm< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.api.html#module-music.api.spotify" > api.spotify< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.api.html#module-music.api.tag" > api.tag< / a > < / li >
2021-03-23 22:46:23 +00:00
< / ul >
< / li >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "music.auth.html" > music.auth< / a > < ul >
2021-03-23 22:46:23 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "music.auth.html#module-music.auth" > Module contents< / a > < / li >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "music.auth.html#module-music.auth.auth" > auth.auth< / a > < / li >
2021-03-23 22:46:23 +00:00
< / ul >
< / li >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "music.cloud.html" > music.cloud< / a > < ul >
2021-03-23 22:46:23 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "music.cloud.html#module-music.cloud" > Module contents< / a > < / li >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "music.cloud.html#module-music.cloud.function" > cloud.function< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.cloud.html#module-music.cloud.tasks" > cloud.tasks< / a > < / li >
2021-03-23 22:46:23 +00:00
< / ul >
< / li >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "music.db.html" > music.db< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.db.html#module-music.db" > Module contents< / a > < / li >
2021-03-27 00:10:03 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "music.db.html#module-music.db.database" > db.database< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.db.html#module-music.db.part_generator" > db.part_generator< / a > < / li >
2021-03-23 22:46:23 +00:00
< / ul >
< / li >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "music.model.html" > music.model< / a > < ul >
2021-03-23 22:46:23 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "music.model.html#module-music.model" > Module contents< / a > < / li >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "music.model.html#module-music.model.config" > model.config< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.model.html#module-music.model.playlist" > model.playlist< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.model.html#module-music.model.tag" > model.tag< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.model.html#module-music.model.user" > model.user< / a > < / li >
2021-03-23 22:46:23 +00:00
< / ul >
< / li >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "music.tasks.html" > music.tasks< / a > < ul >
2021-03-23 22:46:23 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "music.tasks.html#module-music.tasks" > Module contents< / a > < / li >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "music.tasks.html#module-music.tasks.create_playlist" > tasks.create_playlist< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.tasks.html#module-music.tasks.refresh_lastfm_stats" > tasks.refresh_lastfm_stats< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.tasks.html#module-music.tasks.run_user_playlist" > tasks.run_user_playlist< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "music.tasks.html#module-music.tasks.update_tag" > tasks.update_tag< / a > < / li >
2021-03-23 22:46:23 +00:00
< / ul >
< / li >
< / ul >
< / div >
2021-04-04 19:52:28 +01:00
< / section >
< section id = "module-music" >
2021-03-24 10:15:52 +00:00
< span id = "module-contents" > < / span > < h2 > Module contents< a class = "headerlink" href = "#module-music" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Root module containing Music Tools backend< / p >
< p > Top level module with functions for creating app with loaded blueprints and initialising the logging stack< / p >
< dl class = "py function" >
< dt id = "music.init_log" >
< code class = "sig-prename descclassname" > < span class = "pre" > music.< / span > < / code > < code class = "sig-name descname" > < span class = "pre" > init_log< / span > < / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > cloud< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > False< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > console< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > False< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#music.init_log" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2021-04-04 19:52:28 +01:00
< / section >
< section id = "module-music.music" >
2021-03-23 22:46:23 +00:00
< span id = "music-music-module" > < / span > < h2 > music.music module< a class = "headerlink" href = "#module-music.music" title = "Permalink to this headline" > ¶< / a > < / h2 >
< dl class = "py function" >
< dt id = "music.music.create_app" >
< code class = "sig-prename descclassname" > < span class = "pre" > music.music.< / span > < / code > < code class = "sig-name descname" > < span class = "pre" > create_app< / span > < / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#music.music.create_app" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Generate and retrieve a ready-to-run flask app< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > Music Tools app< / p >
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > Flask App< / p >
< / dd >
< / dl >
< / dd > < / dl >
2021-04-04 19:52:28 +01:00
< / section >
< / section >
2021-03-23 22:46:23 +00:00
< / 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 >
2021-04-04 19:52:28 +01:00
< p > < span class = "caption-text" > Contents:< / span > < / p >
2021-03-23 22:46:23 +00:00
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "modules.html" > Modules< / a > < / li >
2021-03-24 10:15:52 +00:00
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > music< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "music.api.html" > music.api< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "music.auth.html" > music.auth< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "music.cloud.html" > music.cloud< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "music.db.html" > music.db< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "music.model.html" > music.model< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "music.tasks.html" > music.tasks< / a > < / li >
2021-03-23 22:46:23 +00:00
< / ul >
< div class = "relations" >
< h3 > Related Topics< / h3 >
< ul >
< li > < a href = "../index.html" > Documentation overview< / a > < ul >
< li > < a href = "modules.html" > music< / a > < ul >
< li > Previous: < a href = "modules.html" title = "previous chapter" > music< / a > < / li >
2021-03-24 10:15:52 +00:00
< li > Next: < a href = "music.api.html" title = "next chapter" > music.api< / a > < / li >
2021-03-23 22:46:23 +00:00
< / ul > < / 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" >
© 2021, Sarsoo.
|
Powered by < a href = "http://sphinx-doc.org/" > Sphinx 3.5.3< / a >
& < a href = "https://github.com/bitprophet/alabaster" > Alabaster 0.7.12< / a >
|
< a href = "../_sources/src/music.rst.txt"
rel="nofollow">Page source< / a >
< / div >
< / body >
< / html >