193 lines
8.5 KiB
HTML
193 lines
8.5 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="../">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>Project Layout — Flask Documentation (3.2.x)</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6625fa76" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/flask.css?v=b87c8d14" />
|
||
<script src="../_static/documentation_options.js?v=56528222"></script>
|
||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script data-project="flask" data-version="3.2.x" src="../_static/describe_version.js?v=fa7f30d0"></script>
|
||
<link rel="icon" href="../_static/shortcut-icon.png"/>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Application Setup" href="factory.html" />
|
||
<link rel="prev" title="Tutorial" href="index.html" />
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="factory.html" title="Application Setup"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="index.html" title="Tutorial"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Flask Documentation (3.2.x)</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Tutorial</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Project Layout</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="project-layout">
|
||
<h1>Project Layout<a class="headerlink" href="#project-layout" title="Link to this heading">¶</a></h1>
|
||
<p>Create a project directory and enter it:</p>
|
||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>$ mkdir flask-tutorial
|
||
$ cd flask-tutorial
|
||
</pre></div>
|
||
</div>
|
||
<p>Then follow the <a class="reference internal" href="../installation.html"><span class="doc">installation instructions</span></a> to set
|
||
up a Python virtual environment and install Flask for your project.</p>
|
||
<p>The tutorial will assume you’re working from the <code class="docutils literal notranslate"><span class="pre">flask-tutorial</span></code>
|
||
directory from now on. The file names at the top of each code block are
|
||
relative to this directory.</p>
|
||
<hr class="docutils" />
|
||
<p>A Flask application can be as simple as a single file.</p>
|
||
<div class="literal-block-wrapper docutils container" id="id1">
|
||
<div class="code-block-caption"><span class="caption-text"><code class="docutils literal notranslate"><span class="pre">hello.py</span></code></span><a class="headerlink" href="#id1" title="Link to this code">¶</a></div>
|
||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">flask</span><span class="w"> </span><span class="kn">import</span> <span class="n">Flask</span>
|
||
|
||
<span class="n">app</span> <span class="o">=</span> <span class="n">Flask</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
|
||
|
||
|
||
<span class="nd">@app</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">hello</span><span class="p">():</span>
|
||
<span class="k">return</span> <span class="s1">'Hello, World!'</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<p>However, as a project gets bigger, it becomes overwhelming to keep all
|
||
the code in one file. Python projects use <em>packages</em> to organize code
|
||
into multiple modules that can be imported where needed, and the
|
||
tutorial will do this as well.</p>
|
||
<p>The project directory will contain:</p>
|
||
<ul class="simple">
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">flaskr/</span></code>, a Python package containing your application code and
|
||
files.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">tests/</span></code>, a directory containing test modules.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">.venv/</span></code>, a Python virtual environment where Flask and other
|
||
dependencies are installed.</p></li>
|
||
<li><p>Installation files telling Python how to install your project.</p></li>
|
||
<li><p>Version control config, such as <a class="reference external" href="https://git-scm.com/">git</a>. You should make a habit of
|
||
using some type of version control for all your projects, no matter
|
||
the size.</p></li>
|
||
<li><p>Any other project files you might add in the future.</p></li>
|
||
</ul>
|
||
<p>By the end, your project layout will look like this:</p>
|
||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>/home/user/Projects/flask-tutorial
|
||
├── flaskr/
|
||
│ ├── __init__.py
|
||
│ ├── db.py
|
||
│ ├── schema.sql
|
||
│ ├── auth.py
|
||
│ ├── blog.py
|
||
│ ├── templates/
|
||
│ │ ├── base.html
|
||
│ │ ├── auth/
|
||
│ │ │ ├── login.html
|
||
│ │ │ └── register.html
|
||
│ │ └── blog/
|
||
│ │ ├── create.html
|
||
│ │ ├── index.html
|
||
│ │ └── update.html
|
||
│ └── static/
|
||
│ └── style.css
|
||
├── tests/
|
||
│ ├── conftest.py
|
||
│ ├── data.sql
|
||
│ ├── test_factory.py
|
||
│ ├── test_db.py
|
||
│ ├── test_auth.py
|
||
│ └── test_blog.py
|
||
├── .venv/
|
||
├── pyproject.toml
|
||
└── MANIFEST.in
|
||
</pre></div>
|
||
</div>
|
||
<p>If you’re using version control, the following files that are generated
|
||
while running your project should be ignored. There may be other files
|
||
based on the editor you use. In general, ignore files that you didn’t
|
||
write. For example, with git:</p>
|
||
<div class="literal-block-wrapper docutils container" id="id2">
|
||
<div class="code-block-caption"><span class="caption-text"><code class="docutils literal notranslate"><span class="pre">.gitignore</span></code></span><a class="headerlink" href="#id2" title="Link to this code">¶</a></div>
|
||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>.venv/
|
||
|
||
*.pyc
|
||
__pycache__/
|
||
|
||
instance/
|
||
|
||
.pytest_cache/
|
||
.coverage
|
||
htmlcov/
|
||
|
||
dist/
|
||
build/
|
||
*.egg-info/
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<p>Continue to <a class="reference internal" href="factory.html"><span class="doc">Application Setup</span></a>.</p>
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<span id="sidebar-top"></span>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
|
||
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/flask-vertical.png" alt="Logo of Flask"/>
|
||
</a></p>
|
||
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li><a href="../index.html">Overview</a>
|
||
<ul>
|
||
<li><a href="index.html">Tutorial</a>
|
||
<ul>
|
||
<li>Previous: <a href="index.html" title="previous chapter">Tutorial</a>
|
||
<li>Next: <a href="factory.html" title="next chapter">Application Setup</a></ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script><div id="ethical-ad-placement"></div>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2010 Pallets.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
|
||
</div>
|
||
</body>
|
||
</html>
|