304 lines
12 KiB
HTML
304 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>Generate A Quart-Imp Blueprint | Quart-Imp</title>
|
|
<link rel="stylesheet" href="static/water.css">
|
|
<link rel="stylesheet" href="static/pygments.emacs-dull.css">
|
|
<link rel="apple-touch-icon" sizes="180x180" href="static/apple-touch-icon.png">
|
|
<link rel="icon" type="image/png" sizes="32x32" href="static/favicon-32x32.png">
|
|
<link rel="icon" type="image/png" sizes="16x16" href="static/favicon-16x16.png">
|
|
<link rel="manifest" href="static/site.webmanifest">
|
|
<link rel="mask-icon" href="static/safari-pinned-tab.svg" color="#5bbad5">
|
|
<meta name="msapplication-TileColor" content="#da532c">
|
|
<meta name="theme-color" content="#ffffff">
|
|
</head>
|
|
<body>
|
|
|
|
<aside>
|
|
<img src="static/quart-Imp-Medium.png" alt="Quart-Imp Logo" style="margin-top: 20px; width: 50%">
|
|
<h1>Quart-Imp</h1>
|
|
<div><small>Version: 1.0.x</small></div>
|
|
<div><small>Last Updated:</small></div>
|
|
<div><small>Fri, 16 Aug 2024</small></div>
|
|
<h2>Menu</h2>
|
|
<ul>
|
|
<li><a href="index.html"><strong>Index</strong></a></li>
|
|
</ul>
|
|
<ul>
|
|
|
|
|
|
<li><strong>CLI Commands</strong></li>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="cli_commands-quart-imp_init.html">quart-imp init</a></li>
|
|
|
|
|
|
|
|
<li><a href="cli_commands-quart-imp_blueprint.html">quart-imp blueprint</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<li><strong>Imp</strong></li>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="imp-introduction.html">Introduction</a></li>
|
|
|
|
|
|
|
|
<li><a href="imp-init_app-init.html">init_app, __init__</a></li>
|
|
|
|
|
|
|
|
<li><a href="imp-init_session.html">init_session</a></li>
|
|
|
|
|
|
|
|
<li><a href="imp-import_app_resources.html">import_app_resources</a></li>
|
|
|
|
|
|
|
|
<li><a href="imp-import_blueprint.html">import_blueprint</a></li>
|
|
|
|
|
|
|
|
<li><a href="imp-import_blueprints.html">import_blueprints</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<li><strong>ImpBlueprint</strong></li>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="impblueprint-introduction.html">Introduction</a></li>
|
|
|
|
|
|
|
|
<li><a href="impblueprint-init.html">__init__</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="impblueprint-import_resources.html">import_resources</a></li>
|
|
|
|
|
|
|
|
<li><a href="impblueprint-import_nested_blueprint.html">import_nested_blueprint</a></li>
|
|
|
|
|
|
|
|
<li><a href="impblueprint-import_nested_blueprints.html">import_nested_blueprints</a></li>
|
|
|
|
|
|
|
|
<li><a href="impblueprint-tmpl.html">tmpl</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<li><strong>quart_imp.config</strong></li>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="quart_imp_config-quartconfig.html">QuartConfig</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_config-impconfig.html">ImpConfig</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_config-impblueprintconfig.html">ImpBlueprintConfig</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<li><strong>quart_imp.security</strong></li>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="quart_imp_security-login_check.html">login_check</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_security-permission_check.html">permission_check</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_security-pass_function_check.html">pass_function_check</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_security-api_login_check.html">api_login_check</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_security-include_csrf.html">include_csrf</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<li><strong>quart_imp.auth</strong></li>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="quart_imp_auth-encrypt_password.html">encrypt_password</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_auth-authenticate_password.html">authenticate_password</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_auth-generate_password.html">generate_password</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_auth-generate_salt.html">generate_salt</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_auth-generate_csrf_token.html">generate_csrf_token</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_auth-generate_private_key.html">generate_private_key</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_auth-generate_email_validator.html">generate_email_validator</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_auth-generate_numeric_validator.html">generate_numeric_validator</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_auth-generate_alphanumeric_validator.html">generate_alphanumeric_validator</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_auth-is_email_address_valid.html">is_email_address_valid</a></li>
|
|
|
|
|
|
|
|
<li><a href="quart_imp_auth-is_username_valid.html">is_username_valid</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</ul>
|
|
|
|
<div style="padding-top: 5px; margin-bottom: 20px;"><small>Hosted on GitHub Pages.</small></div>
|
|
</aside>
|
|
|
|
<section>
|
|
<h1 style="font-size: 2.6rem; margin: 0;">Generate a Quart-Imp Blueprint</h1>
|
|
<p>Quart-Imp has its own type of blueprint. It comes with some methods to auto import routes, and nested blueprints etc...
|
|
see <a href="impblueprint-introduction.html">ImpBlueprint / Introduction</a> for more information.</p>
|
|
<p>You have the option to generate a regular template rendering blueprint, or a API blueprint that returns a JSON response.</p>
|
|
<div class="highlight"><pre><span></span>quart-imp<span class="w"> </span>blueprint<span class="w"> </span>--help
|
|
</pre></div>
|
|
<p>or</p>
|
|
<div class="highlight"><pre><span></span>quart-imp<span class="w"> </span>api-blueprint<span class="w"> </span>--help
|
|
</pre></div>
|
|
<p>To generate a Quart-Imp blueprint, run the following command:</p>
|
|
<div class="highlight"><pre><span></span>quart-imp<span class="w"> </span>blueprint
|
|
</pre></div>
|
|
<p>or</p>
|
|
<div class="highlight"><pre><span></span>quart-imp<span class="w"> </span>api-blueprint
|
|
</pre></div>
|
|
<p>After running this command, you will be prompted to enter the location of where you want to create your blueprint:</p>
|
|
<div class="highlight"><pre><span></span>~ $ quart-imp blueprint
|
|
(Creation is relative to the current working directory)
|
|
Folder to create blueprint in [Current Working Directory]:
|
|
</pre></div>
|
|
<p>As detailed in the prompt, the creation of the blueprint is relative to the current working directory. So to create a
|
|
blueprint in the folder <code>app/blueprints</code>, you would enter <code>app/blueprints</code> in the prompt.</p>
|
|
<div class="highlight"><pre><span></span>~ $ quart-imp blueprint
|
|
(Creation is relative to the current working directory)
|
|
Folder to create blueprint in [Current Working Directory]: app/blueprints
|
|
</pre></div>
|
|
<p>You will then be prompted to enter a name for your blueprint:</p>
|
|
<div class="highlight"><pre><span></span>~ $ quart-imp blueprint
|
|
...
|
|
Name of the blueprint to create [my_new_blueprint]:
|
|
</pre></div>
|
|
<p>The default name is 'my_new_blueprint', we will change this to 'admin'</p>
|
|
<div class="highlight"><pre><span></span>~ $ quart-imp blueprint
|
|
...
|
|
Name of the blueprint to create [my_new_blueprint]: admin
|
|
</pre></div>
|
|
<p>After creating your blueprint, the folder structure will look like this:</p>
|
|
<div class="highlight"><pre><span></span>app/
|
|
├── blueprints
|
|
│ └── admin
|
|
│ ├── routes
|
|
│ │ └── index.py
|
|
│ │
|
|
│ ├── static
|
|
│ │ ├── css
|
|
│ │ │ └── water.css
|
|
│ │ ├── img
|
|
│ │ │ └── quart-imp-logo.png
|
|
│ │ └── js
|
|
│ │ └── main.js
|
|
│ │
|
|
│ ├── templates
|
|
│ │ └── www
|
|
│ │ ├── extends
|
|
│ │ │ └── main.html
|
|
│ │ ├── includes
|
|
│ │ │ ├── footer.html
|
|
│ │ │ └── header.html
|
|
│ │ └── index.html
|
|
│ │
|
|
│ └── __init__.py
|
|
│
|
|
...
|
|
</pre></div>
|
|
<p>This is a self-contained blueprint, so it has its own static, templates and routes folders.
|
|
You can now navigate '/admin'</p>
|
|
<p>You can streamline this process by specifying the name of the blueprint, the folder to
|
|
create it in and the configuration to use, like so:</p>
|
|
<div class="highlight"><pre><span></span>quart-imp<span class="w"> </span>blueprint<span class="w"> </span>-n<span class="w"> </span>admin<span class="w"> </span>-f<span class="w"> </span>app/blueprints
|
|
</pre></div>
|
|
|
|
</section>
|
|
|
|
</body>
|
|
</html> |