<!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.1: http://docutils.sourceforge.net/" /> <title>app — SaaS in a Flask 0.1.0 documentation</title> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css" /> <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> <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.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-app"> <span id="app"></span><h1><a class="reference internal" href="#module-app" title="app"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app</span></code></a><a class="headerlink" href="#module-app" title="Permalink to this headline">¶</a></h1> <section id="subpackages"> <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="forms/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.forms</span></code></a><ul> <li class="toctree-l2"><a class="reference internal" href="forms/app_forms/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.forms.app_forms</span></code></a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="tests/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests</span></code></a><ul> <li class="toctree-l2"><a class="reference internal" href="tests/conftest/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.conftest</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="tests/test_admin/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_admin</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="tests/test_cli/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_cli</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="tests/test_fastapi/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_fastapi</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="tests/test_forms/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_forms</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="tests/test_models/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_models</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="tests/test_views/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.tests.test_views</span></code></a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="views/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views</span></code></a><ul> <li class="toctree-l2"><a class="reference internal" href="views/admin/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.admin</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="views/auth/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.auth</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="views/error_pages/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.error_pages</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="views/main/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.main</span></code></a></li> </ul> </li> </ul> </div> </section> <section id="submodules"> <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="apis/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.apis</span></code></a></li> <li class="toctree-l1"><a class="reference internal" href="config/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.config</span></code></a></li> <li class="toctree-l1"><a class="reference internal" href="config_dev/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.config_dev</span></code></a></li> <li class="toctree-l1"><a class="reference internal" href="misc_func/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.misc_func</span></code></a></li> <li class="toctree-l1"><a class="reference internal" href="models/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.models</span></code></a></li> </ul> </div> </section> <section id="package-contents"> <h2>Package Contents<a class="headerlink" href="#package-contents" title="Permalink to this headline">¶</a></h2> <section id="functions"> <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> <table class="longtable docutils align-default"> <colgroup> <col style="width: 10%" /> <col style="width: 90%" /> </colgroup> <tbody> <tr class="row-odd"><td><p><a class="reference internal" href="#app.create_database" title="app.create_database"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_database</span></code></a>()</p></td> <td><p></p></td> </tr> <tr class="row-even"><td><p><a class="reference internal" href="#app.delete_database" title="app.delete_database"><code class="xref py py-obj docutils literal notranslate"><span class="pre">delete_database</span></code></a>()</p></td> <td><p></p></td> </tr> <tr class="row-odd"><td><p><a class="reference internal" href="#app.make_superuser_database" title="app.make_superuser_database"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_superuser_database</span></code></a>()</p></td> <td><p></p></td> </tr> <tr class="row-even"><td><p><a class="reference internal" href="#app.load_user" title="app.load_user"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_user</span></code></a>(email)</p></td> <td><p></p></td> </tr> </tbody> </table> </section> <section id="attributes"> <h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this headline">¶</a></h3> <table class="longtable docutils align-default"> <colgroup> <col style="width: 10%" /> <col style="width: 90%" /> </colgroup> <tbody> <tr class="row-odd"><td><p><a class="reference internal" href="#app.app" title="app.app"><code class="xref py py-obj docutils literal notranslate"><span class="pre">app</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-even"><td><p><a class="reference internal" href="#app.bcrypt" title="app.bcrypt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bcrypt</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-odd"><td><p><a class="reference internal" href="#app.db" title="app.db"><code class="xref py py-obj docutils literal notranslate"><span class="pre">db</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-even"><td><p><a class="reference internal" href="#app.login_manager" title="app.login_manager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">login_manager</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-odd"><td><p><a class="reference internal" href="#app.oauth" title="app.oauth"><code class="xref py py-obj docutils literal notranslate"><span class="pre">oauth</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-even"><td><p><a class="reference internal" href="#app.mail" title="app.mail"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mail</span></code></a></p></td> <td><p></p></td> </tr> <tr class="row-odd"><td><p><a class="reference internal" href="#app.database_cli" title="app.database_cli"><code class="xref py py-obj docutils literal notranslate"><span class="pre">database_cli</span></code></a></p></td> <td><p></p></td> </tr> </tbody> </table> <dl class="py data"> <dt class="sig sig-object py" id="app.app"> <span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">app</span></span><a class="headerlink" href="#app.app" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py data"> <dt class="sig sig-object py" id="app.bcrypt"> <span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">bcrypt</span></span><a class="headerlink" href="#app.bcrypt" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py data"> <dt class="sig sig-object py" id="app.db"> <span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">db</span></span><a class="headerlink" href="#app.db" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py data"> <dt class="sig sig-object py" id="app.login_manager"> <span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">login_manager</span></span><a class="headerlink" href="#app.login_manager" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py data"> <dt class="sig sig-object py" id="app.oauth"> <span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">oauth</span></span><a class="headerlink" href="#app.oauth" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py data"> <dt class="sig sig-object py" id="app.mail"> <span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">mail</span></span><a class="headerlink" href="#app.mail" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py data"> <dt class="sig sig-object py" id="app.database_cli"> <span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">database_cli</span></span><a class="headerlink" href="#app.database_cli" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="app.create_database"> <span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">create_database</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.create_database" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="app.delete_database"> <span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">delete_database</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.delete_database" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="app.make_superuser_database"> <span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">make_superuser_database</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.make_superuser_database" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="app.load_user"> <span class="sig-prename descclassname"><span class="pre">app.</span></span><span class="sig-name descname"><span class="pre">load_user</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.load_user" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </section> </section> </section> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h1 class="logo"><a href="../../index.html">SaaS in a Flask</a></h1> <h3>Navigation</h3> <p class="caption"><span class="caption-text">Contents:</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../index.html">API Reference</a></li> </ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="../../index.html">Documentation overview</a><ul> </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, Navan Chauhan. | Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> | <a href="../../_sources/autoapi/app/index.rst.txt" rel="nofollow">Page source</a> </div> </body> </html>