deploy: c478bce

Aedial · May 18, 2023 · 7335b7a · 7335b7a
1 parent ed1b3ba
commit 7335b7a
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 11 deletions.
diff --git a/_modules/novelai_api/ImagePreset.html b/_modules/novelai_api/ImagePreset.html
@@ -291,8 +291,8 @@ <h1>Source code for novelai_api.ImagePreset</h1><div class="highlight"><pre>
         <span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TYPE_MAPPING</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;&#39;</span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2">&#39; is not a valid setting&quot;</span><span class="p">)</span>
 
-        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TYPE_MAPPING</span><span class="p">[</span><span class="n">key</span><span class="p">]):</span>  <span class="c1"># noqa (pycharm PY-36317)</span>
-            <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Expected type &#39;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_TYPE_MAPPING</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="si">}</span><span class="s2">&#39; for </span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2">, but got type &#39;</span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TYPE_MAPPING</span><span class="p">[</span><span class="n">key</span><span class="p">]):</span>  <span class="c1"># noqa (pycharm PY-36317)</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Expected type &#39;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_TYPE_MAPPING</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="si">}</span><span class="s2">&#39; for </span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2">, but got type &#39;</span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;&quot;</span><span class="p">)</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">_settings</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
 

diff --git a/_modules/novelai_api/Preset.html b/_modules/novelai_api/Preset.html
@@ -286,8 +286,8 @@ <h1>Source code for novelai_api.Preset</h1><div class="highlight"><pre>
         <span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TYPE_MAPPING</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;&#39;</span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2">&#39; is not a valid setting&quot;</span><span class="p">)</span>
 
-        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TYPE_MAPPING</span><span class="p">[</span><span class="n">key</span><span class="p">]):</span>  <span class="c1"># noqa (pycharm PY-36317)</span>
-            <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Expected type &#39;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_TYPE_MAPPING</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="si">}</span><span class="s2">&#39; for </span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2">, but got type &#39;</span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TYPE_MAPPING</span><span class="p">[</span><span class="n">key</span><span class="p">]):</span>  <span class="c1"># noqa (pycharm PY-36317)</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Expected type &#39;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_TYPE_MAPPING</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="si">}</span><span class="s2">&#39; for </span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2">, but got type &#39;</span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;&quot;</span><span class="p">)</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">_settings</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
 

diff --git a/index.html b/index.html
@@ -76,10 +76,10 @@ <h1>novelai-api<a class="headerlink" href="#novelai-api" title="Permalink to thi
 <td><p><a class="reference external" href="https://github.com/Aedial/novelai-api/actions/workflows/python-package.yml"><img alt="Python package" src="https://github.com/Aedial/novelai-api/actions/workflows/python-package.yml/badge.svg" /></a> <a class="reference external" href="https://github.com/Aedial/novelai-api/actions/workflows/codeql-analysis.yml"><img alt="Python package" src="https://github.com/Aedial/novelai-api/actions/workflows/codeql-analysis.yml/badge.svg" /></a> <a class="reference external" href="https://github.com/PyCQA/pylint"><img alt="linting: pylint" src="https://img.shields.io/badge/linting-pylint-yellowgreen" /></a> <a class="reference external" href="https://github.com/PyCQA/bandit"><img alt="security: bandit" src="https://img.shields.io/badge/security-bandit-yellow.svg" /></a> <a class="reference external" href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg" /></a></p></td>
 </tr>
 <tr class="row-even"><td><p>Stats</p></td>
-<td><p><a class="reference external" href="https://github.com/Aedial/novelai-api/search?l=python"><img alt="GitHub top language" src="https://img.shields.io/github/languages/top/Aedial/novelai-api" /></a> <img alt="Libraries.io dependency status for GitHub repo" src="https://img.shields.io/librariesio/github/Aedial/novelai-api" /> <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/Aedial/novelai-api" /> <img alt="GitHub issues" src="https://img.shields.io/github/issues-raw/Aedial/novelai-api" /> <img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr-raw/Aedial/novelai-api" /></p></td>
+<td><p><a class="reference external" href="https://github.com/Aedial/novelai-api/search?l=python"><img alt="GitHub top language" src="https://img.shields.io/github/languages/top/Aedial/novelai-api" /></a> <img alt="Libraries.io dependency status for GitHub repo" src="https://img.shields.io/librariesio/github/Aedial/novelai-api" /> <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/Aedial/novelai-api" /> <img alt="Pypi package size" src="https://byob.yarr.is/Aedial/novelai-api/pypi-size" /> <img alt="GitHub issues" src="https://img.shields.io/github/issues-raw/Aedial/novelai-api" /> <img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr-raw/Aedial/novelai-api" /></p></td>
 </tr>
 <tr class="row-odd"><td><p>Activity</p></td>
-<td><p><img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/Aedial/novelai-api" /> <img alt="GitHub commits since tagged version" src="https://img.shields.io/github/commits-since/Aedial/novelai-api/v0.12.0" /> <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/Aedial/novelai-api" /></p></td>
+<td><p><img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/Aedial/novelai-api" /> <img alt="GitHub commits since tagged version" src="https://img.shields.io/github/commits-since/Aedial/novelai-api/0.12.1" /> <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/Aedial/novelai-api" /></p></td>
 </tr>
 </tbody>
 </table>
@@ -106,21 +106,24 @@ <h2>high_level<a class="headerlink" href="#high-level" title="Permalink to this
 </section>
 <section id="development">
 <h1>Development<a class="headerlink" href="#development" title="Permalink to this heading">¶</a></h1>
-<p>All relevant objects are in the <a class="reference external" href="https://github.com/Aedial/novelai-api/tree/main/novelai_api">novelai_api</a> directory. The <a class="reference external" href="https://pypi.org/project/nox/">nox</a> package is required (<code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">nox</span></code>).</p>
+<p>All relevant objects are in the <a class="reference external" href="https://github.com/Aedial/novelai-api/tree/main/novelai_api">novelai_api</a> directory.
+The <a class="reference external" href="https://pypi.org/project/poetry/">Poetry</a> package is required (<code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">poetry</span></code>) as the venv manager.</p>
 <section id="contributing">
 <h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this heading">¶</a></h2>
 <p>You can contribute features and enhancements through PR. Any PR should pass the tests and the pre-commits before submission.
 The pre-commit hook can be installed via</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">nox</span> <span class="o">-</span><span class="n">s</span> <span class="n">pre</span><span class="o">-</span><span class="n">commit</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">poetry</span> <span class="n">run</span> <span class="n">nai</span><span class="o">-</span><span class="n">pre</span><span class="o">-</span><span class="n">commit</span>
 </pre></div>
 </div>
 </section>
 <section id="testing-against-the-api">
 <h2>Testing against the API<a class="headerlink" href="#testing-against-the-api" title="Permalink to this heading">¶</a></h2>
-<p><a class="reference external" href="https://github.com/Aedial/novelai-api/tree/main/tests/api">API</a></p>
+<p>To run against the API, you can use <code class="docutils literal notranslate"><span class="pre">poetry</span> <span class="pre">run</span> <span class="pre">nai-test-api</span></code>.
+<a class="reference external" href="https://github.com/Aedial/novelai-api/tree/main/tests/api">API</a></p>
 </section>
 <section id="testing-against-the-mocked-api">
 <h2>Testing against the mocked API<a class="headerlink" href="#testing-against-the-mocked-api" title="Permalink to this heading">¶</a></h2>
+<p>To run against the mocked API, you can use <code class="docutils literal notranslate"><span class="pre">poetry</span> <span class="pre">run</span> <span class="pre">nai-test-mock</span></code>.</p>
 <table class="docutils align-default">
 <thead>
 <tr class="row-odd"><th class="head"><p>:warning: WIP, does not work yet :warning:</p></th>
@@ -132,7 +135,7 @@ <h2>Testing against the mocked API<a class="headerlink" href="#testing-against-t
 <section id="docs">
 <h2>Docs<a class="headerlink" href="#docs" title="Permalink to this heading">¶</a></h2>
 <p>To build the docs, run</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">nox</span> <span class="o">-</span><span class="n">s</span> <span class="n">build</span><span class="o">-</span><span class="n">docs</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">poetry</span> <span class="n">run</span> <span class="n">nai</span><span class="o">-</span><span class="n">build</span><span class="o">-</span><span class="n">docs</span>
 </pre></div>
 </div>
 <p>The docs will be locally viewable at docs/build/html/index.html</p>

diff --git a/searchindex.js b/searchindex.js