d3vyce/fastapi-toolsets
1
0
Fork 0
mirror of https://github.com/d3vyce/fastapi-toolsets.git synced 2026-08-04 23:54:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deployed c15aee2 to v5.0 with Zensical 0.0.50 and mike 2.2.0+zensical-0.1.0

Browse Source
This commit is contained in:
github-actions[bot]
2026-07-11 13:17:37 +00:00
parent c9285b0fb8
commit c6d31cdac9
42 changed files with 3287 additions and 8748 deletions
Download Patch File Download Diff File Expand all files Collapse all files
v5.0/module/cli/index.html
+88 -80
View File
@@ -25,7 +25,7 @@
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="zensical-0.0.43">
<meta name="generator" content="zensical-0.0.50">
@@ -36,7 +36,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/modern/main.fba56155.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/modern/main.62c9b9cc.min.css">
@@ -252,8 +252,6 @@
@@ -300,8 +298,6 @@
@@ -361,12 +357,14 @@
<li class="md-tabs__item">
<a href="../../migration/v4/" class="md-tabs__link">
<a href="../../migration/v5/" class="md-tabs__link">
Migration
@@ -494,8 +492,6 @@
@@ -652,6 +648,23 @@
</span>
</a>
<nav class="md-nav" aria-label="Usage">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#fixtures-load" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
<code>fixtures load</code>
</span>
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -944,33 +957,6 @@
<li class="md-nav__item">
<a href="../security/" class="md-nav__link">
<span class="md-ellipsis">
Security
</span>
</a>
</li>
</ul>
</nav>
@@ -1006,8 +992,6 @@
@@ -1351,33 +1335,6 @@
<li class="md-nav__item">
<a href="../../reference/security/" class="md-nav__link">
<span class="md-ellipsis">
Security
</span>
</a>
</li>
</ul>
</nav>
@@ -1488,6 +1445,8 @@
@@ -1537,6 +1496,33 @@
<li class="md-nav__item">
<a href="../../migration/v5/" class="md-nav__link">
<span class="md-ellipsis">
v5.0
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../migration/v4/" class="md-nav__link">
@@ -1727,6 +1713,23 @@
</span>
</a>
<nav class="md-nav" aria-label="Usage">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#fixtures-load" class="md-nav__link">
<span class="md-ellipsis">
<span class="md-typeset">
<code>fixtures load</code>
</span>
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -1803,8 +1806,6 @@
@@ -1865,7 +1866,7 @@
<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h2>
<p>Configure the CLI in your <code>pyproject.toml</code>:</p>
<div class="language-toml highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="k">[tool.fastapi-toolsets]</span>
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="n">cli</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;myapp.cli:cli&quot;</span><span class="w"> </span><span class="c1"># Custom Typer app</span>
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="n">custom_cli</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;myapp.cli:cli&quot;</span><span class="w"> </span><span class="c1"># Custom Typer app</span>
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="n">fixtures</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;myapp.fixtures:registry&quot;</span><span class="w"> </span><span class="c1"># FixtureRegistry instance</span>
</span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="n">db_context</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;myapp.db:db_context&quot;</span><span class="w"> </span><span class="c1"># Async context manager for sessions</span>
</span></code></pre></div>
@@ -1904,19 +1905,26 @@
</span><span id="__span-3-31"><a id="__codelineno-3-31" name="__codelineno-3-31" href="#__codelineno-3-31"></a>│<span class="w"> </span>load<span class="w"> </span>Load<span class="w"> </span>fixtures<span class="w"> </span>into<span class="w"> </span>the<span class="w"> </span>database.<span class="w"> </span>│
</span><span id="__span-3-32"><a id="__codelineno-3-32" name="__codelineno-3-32" href="#__codelineno-3-32"></a>╰──────────────────────────────────────────────────────────────────────────────────╯
</span></code></pre></div>
<h3 id="fixtures-load"><code>fixtures load</code><a class="headerlink" href="#fixtures-load" title="Permanent link">&para;</a></h3>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>manager<span class="w"> </span>fixtures<span class="w"> </span>load<span class="w"> </span><span class="o">[</span>CONTEXTS<span class="o">]</span>...<span class="w"> </span><span class="o">[</span>--strategy<span class="w"> </span>merge<span class="p">|</span>insert<span class="p">|</span>skip_existing<span class="o">]</span><span class="w"> </span><span class="o">[</span>--dry-run<span class="o">]</span>
</span></code></pre></div>
<p><code>CONTEXTS</code> defaults to <code>Context.BASE</code> when omitted, and can also be set via the <code>FIXTURES_CONTEXT</code> environment variable, handy for CI/deploy scripts that shouldn't need an explicit argument per environment:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nv">FIXTURES_CONTEXT</span><span class="o">=</span>testing<span class="w"> </span>manager<span class="w"> </span>fixtures<span class="w"> </span>load
</span></code></pre></div>
<p>An explicit CLI argument always takes precedence over the environment variable.</p>
<h2 id="custom-cli">Custom CLI<a class="headerlink" href="#custom-cli" title="Permanent link">&para;</a></h2>
<p>You can extend the CLI by providing your own Typer app. The <code>manager</code> entry point will merge your app's commands with the built-in ones:</p>
<div class="language-python highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c1"># myapp/cli.py</span>
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="kn">import</span><span class="w"> </span><span class="nn">typer</span>
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>
</span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="n">cli</span> <span class="o">=</span> <span class="n">typer</span><span class="o">.</span><span class="n">Typer</span><span class="p">()</span>
</span><span id="__span-4-5"><a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>
</span><span id="__span-4-6"><a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="nd">@cli</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
</span><span id="__span-4-7"><a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="k">def</span><span class="w"> </span><span class="nf">hello</span><span class="p">():</span>
</span><span id="__span-4-8"><a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a> <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Hello from my app!&quot;</span><span class="p">)</span>
<div class="language-python highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># myapp/cli.py</span>
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="kn">import</span><span class="w"> </span><span class="nn">typer</span>
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>
</span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="n">cli</span> <span class="o">=</span> <span class="n">typer</span><span class="o">.</span><span class="n">Typer</span><span class="p">()</span>
</span><span id="__span-6-5"><a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a>
</span><span id="__span-6-6"><a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="nd">@cli</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
</span><span id="__span-6-7"><a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a><span class="k">def</span><span class="w"> </span><span class="nf">hello</span><span class="p">():</span>
</span><span id="__span-6-8"><a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a> <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Hello from my app!&quot;</span><span class="p">)</span>
</span></code></pre></div>
<div class="language-toml highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="k">[tool.fastapi-toolsets]</span>
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="n">cli</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;myapp.cli:cli&quot;</span>
<div class="language-toml highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="k">[tool.fastapi-toolsets]</span>
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="n">custom_cli</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;myapp.cli:cli&quot;</span>
</span></code></pre></div>
<hr />
<p><a href="../../reference/cli/"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7 7H5a2 2 0 0 0-2 2v8h2v-4h2v4h2V9a2 2 0 0 0-2-2m0 4H5V9h2m7-2h-4v10h2v-4h2a2 2 0 0 0 2-2V9a2 2 0 0 0-2-2m0 4h-2V9h2m6 0v6h1v2h-4v-2h1V9h-1V7h4v2Z"/></svg></span> API Reference</a></p>
@@ -2023,10 +2031,10 @@
<script id="__config" type="application/json">{"annotate":null,"base":"../..","features":["announce.dismiss","content.action.view","content.code.annotate","content.code.copy","content.code.select","content.footnote.tooltips","content.tabs.link","content.tooltips","navigation.footer","navigation.indexes","navigation.instant","navigation.instant.prefetch","navigation.path","navigation.sections","navigation.tabs","navigation.top","navigation.tracking","search.highlight"],"search":"../../assets/javascripts/workers/search.e2d2d235.min.js","tags":null,"translations":{"clipboard.copied":"Copied to clipboard","clipboard.copy":"Copy to clipboard","search.result.more.one":"1 more on this page","search.result.more.other":"# more on this page","search.result.none":"No matching documents","search.result.one":"1 matching document","search.result.other":"# matching documents","search.result.placeholder":"Type to start searching","search.result.term.missing":"Missing","select.version":"Select version"},"version":{"alias":true,"default":"stable","provider":"mike"}}</script>
<script id="__config" type="application/json">{"annotate":null,"base":"../..","features":["announce.dismiss","content.action.view","content.code.annotate","content.code.copy","content.code.select","content.footnote.tooltips","content.tabs.link","content.tooltips","navigation.footer","navigation.indexes","navigation.instant","navigation.instant.prefetch","navigation.path","navigation.sections","navigation.tabs","navigation.top","navigation.tracking","search.highlight"],"search":"../../assets/javascripts/workers/search.b6b7e04f.min.js","tags":null,"translations":{"clipboard.copied":"Copied to clipboard","clipboard.copy":"Copy to clipboard","search.result.more.one":"1 more on this page","search.result.more.other":"# more on this page","search.result.none":"No matching documents","search.result.one":"1 matching document","search.result.other":"# matching documents","search.result.placeholder":"Type to start searching","search.result.term.missing":"Missing","select.version":"Select version"},"version":{"alias":true,"default":"stable","provider":"mike"}}</script>
<script src="../../assets/javascripts/bundle.6e5f0216.min.js"></script>
<script src="../../assets/javascripts/bundle.d7f30b55.min.js"></script>
</body>