vmklib
Advanced tools
Sorry, the diff of this file is too big to display
+4
-15
| Metadata-Version: 2.4 | ||
| Name: vmklib | ||
| Version: 2.0.11 | ||
| Version: 2.0.12 | ||
| Summary: Simplify project workflows by standardizing use of GNU Make. | ||
@@ -22,4 +22,4 @@ Home-page: https://github.com/libre-embedded/vmklib | ||
| License-File: LICENSE | ||
| Requires-Dist: experimental-lowqa>=0.1.12 | ||
| Requires-Dist: vcorelib>=3.6.7 | ||
| Requires-Dist: experimental-lowqa>=0.2.1 | ||
| Provides-Extra: test | ||
@@ -49,7 +49,7 @@ Requires-Dist: pylint; extra == "test" | ||
| version=3.2.3 | ||
| hash=4f511a6c30ac02e87798ca5ac4bd5f94 | ||
| hash=840dae6ff36d11c17a8245212897c333 | ||
| ===================================== | ||
| --> | ||
| # vmklib ([2.0.11](https://pypi.org/project/vmklib/)) | ||
| # vmklib ([2.0.12](https://pypi.org/project/vmklib/)) | ||
@@ -97,13 +97,2 @@ [](https://pypi.org/project/vmklib/) | ||
| ## Quick Links | ||
| * [datazen](#datazen) | ||
| * [grip](#grip) | ||
| * [pypi](#pypi) | ||
| * [python](#python) | ||
| * [venv](#venv) | ||
| * [vmklib](#vmklib) | ||
| * [yaml](#yaml) | ||
| * [Dependency Graph](#dependency-graph) | ||
| # Command-line Options | ||
@@ -110,0 +99,0 @@ |
+1
-1
@@ -7,3 +7,3 @@ [build-system] | ||
| name = "vmklib" | ||
| version = "2.0.11" | ||
| version = "2.0.12" | ||
| description = "Simplify project workflows by standardizing use of GNU Make." | ||
@@ -10,0 +10,0 @@ readme = "README.md" |
+2
-13
@@ -5,7 +5,7 @@ <!-- | ||
| version=3.2.3 | ||
| hash=4f511a6c30ac02e87798ca5ac4bd5f94 | ||
| hash=840dae6ff36d11c17a8245212897c333 | ||
| ===================================== | ||
| --> | ||
| # vmklib ([2.0.11](https://pypi.org/project/vmklib/)) | ||
| # vmklib ([2.0.12](https://pypi.org/project/vmklib/)) | ||
@@ -53,13 +53,2 @@ [](https://pypi.org/project/vmklib/) | ||
| ## Quick Links | ||
| * [datazen](#datazen) | ||
| * [grip](#grip) | ||
| * [pypi](#pypi) | ||
| * [python](#python) | ||
| * [venv](#venv) | ||
| * [vmklib](#vmklib) | ||
| * [yaml](#yaml) | ||
| * [Dependency Graph](#dependency-graph) | ||
| # Command-line Options | ||
@@ -66,0 +55,0 @@ |
| Metadata-Version: 2.4 | ||
| Name: vmklib | ||
| Version: 2.0.11 | ||
| Version: 2.0.12 | ||
| Summary: Simplify project workflows by standardizing use of GNU Make. | ||
@@ -22,4 +22,4 @@ Home-page: https://github.com/libre-embedded/vmklib | ||
| License-File: LICENSE | ||
| Requires-Dist: experimental-lowqa>=0.1.12 | ||
| Requires-Dist: vcorelib>=3.6.7 | ||
| Requires-Dist: experimental-lowqa>=0.2.1 | ||
| Provides-Extra: test | ||
@@ -49,7 +49,7 @@ Requires-Dist: pylint; extra == "test" | ||
| version=3.2.3 | ||
| hash=4f511a6c30ac02e87798ca5ac4bd5f94 | ||
| hash=840dae6ff36d11c17a8245212897c333 | ||
| ===================================== | ||
| --> | ||
| # vmklib ([2.0.11](https://pypi.org/project/vmklib/)) | ||
| # vmklib ([2.0.12](https://pypi.org/project/vmklib/)) | ||
@@ -97,13 +97,2 @@ [](https://pypi.org/project/vmklib/) | ||
| ## Quick Links | ||
| * [datazen](#datazen) | ||
| * [grip](#grip) | ||
| * [pypi](#pypi) | ||
| * [python](#python) | ||
| * [venv](#venv) | ||
| * [vmklib](#vmklib) | ||
| * [yaml](#yaml) | ||
| * [Dependency Graph](#dependency-graph) | ||
| # Command-line Options | ||
@@ -110,0 +99,0 @@ |
@@ -1,3 +0,3 @@ | ||
| experimental-lowqa>=0.1.12 | ||
| vcorelib>=3.6.7 | ||
| experimental-lowqa>=0.2.1 | ||
@@ -4,0 +4,0 @@ [test] |
@@ -42,2 +42,3 @@ LICENSE | ||
| vmklib/data/docs/vmklib.tasks.python.html | ||
| vmklib/data/docs/_images/pydeps.svg | ||
| vmklib/data/docs/_modules/index.html | ||
@@ -44,0 +45,0 @@ vmklib/data/docs/_modules/vcorelib/python.html |
| # ===================================== | ||
| # generator=datazen | ||
| # version=3.2.3 | ||
| # hash=466e6e247f0d4c88668873009f88a021 | ||
| # hash=426fc4308f410fced5dd59f4513bdb46 | ||
| # ===================================== | ||
@@ -13,2 +13,2 @@ | ||
| PKG_NAME = "vmklib" | ||
| VERSION = "2.0.11" | ||
| VERSION = "2.0.12" |
@@ -38,3 +38,3 @@ | ||
| <script src="../_static/documentation_options.js?v=55d7fe76"></script> | ||
| <script src="../_static/documentation_options.js?v=96e9dbe8"></script> | ||
| <script src="../_static/doctools.js?v=fd6eb6e6"></script> | ||
@@ -158,3 +158,3 @@ <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> | ||
| <div class="bd-toc-item navbar-nav active"> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Interface Documentation</span></p> | ||
| <ul class="nav bd-sidenav"> | ||
@@ -161,0 +161,0 @@ <li class="toctree-l1 has-children"><a class="reference internal" href="../vmklib.html">vmklib package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
@@ -38,3 +38,3 @@ | ||
| <script src="../../_static/documentation_options.js?v=55d7fe76"></script> | ||
| <script src="../../_static/documentation_options.js?v=96e9dbe8"></script> | ||
| <script src="../../_static/doctools.js?v=fd6eb6e6"></script> | ||
@@ -158,3 +158,3 @@ <script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script> | ||
| <div class="bd-toc-item navbar-nav active"> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Interface Documentation</span></p> | ||
| <ul class="nav bd-sidenav"> | ||
@@ -161,0 +161,0 @@ <li class="toctree-l1 has-children"><a class="reference internal" href="../../vmklib.html">vmklib package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
| const DOCUMENTATION_OPTIONS = { | ||
| VERSION: '2.0.11', | ||
| VERSION: '2.0.12', | ||
| LANGUAGE: 'en', | ||
@@ -4,0 +4,0 @@ COLLAPSE_INDEX: false, |
@@ -38,3 +38,3 @@ | ||
| <script src="_static/documentation_options.js?v=55d7fe76"></script> | ||
| <script src="_static/documentation_options.js?v=96e9dbe8"></script> | ||
| <script src="_static/doctools.js?v=fd6eb6e6"></script> | ||
@@ -158,3 +158,3 @@ <script src="_static/sphinx_highlight.js?v=6ffebe34"></script> | ||
| <div class="bd-toc-item navbar-nav active"> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Interface Documentation</span></p> | ||
| <ul class="nav bd-sidenav"> | ||
@@ -161,0 +161,0 @@ <li class="toctree-l1 has-children"><a class="reference internal" href="vmklib.html">vmklib package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
@@ -11,3 +11,3 @@ | ||
| <title>vmklib — docs</title> | ||
| <title>vmklib (2.0.12) — docs</title> | ||
@@ -40,3 +40,3 @@ | ||
| <script src="_static/documentation_options.js?v=55d7fe76"></script> | ||
| <script src="_static/documentation_options.js?v=96e9dbe8"></script> | ||
| <script src="_static/doctools.js?v=fd6eb6e6"></script> | ||
@@ -161,3 +161,3 @@ <script src="_static/sphinx_highlight.js?v=6ffebe34"></script> | ||
| <div class="bd-toc-item navbar-nav active"> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Interface Documentation</span></p> | ||
| <ul class="nav bd-sidenav"> | ||
@@ -298,3 +298,5 @@ <li class="toctree-l1 has-children"><a class="reference internal" href="vmklib.html">vmklib package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> | ||
| </script> | ||
| <button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip"> | ||
| <span class="fa-solid fa-list"></span> | ||
| </button> | ||
| </div></div> | ||
@@ -310,3 +312,3 @@ | ||
| <div id="jb-print-docs-body" class="onlyprint"> | ||
| <h1>vmklib</h1> | ||
| <h1>vmklib (2.0.12)</h1> | ||
| <!-- Table of contents --> | ||
@@ -316,2 +318,55 @@ <div id="print-main-content"> | ||
| <div> | ||
| <h2> Contents </h2> | ||
| </div> | ||
| <nav aria-label="Page"> | ||
| <ul class="visible nav section-nav flex-column"> | ||
| <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">vmklib (2.0.12)</a><ul class="visible nav section-nav flex-column"> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#python-version-support">Python Version Support</a></li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#platform-support">Platform Support</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#introduction">Introduction</a></li> | ||
| <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#command-line-options">Command-line Options</a></li> | ||
| <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#targets">Targets</a><ul class="visible nav section-nav flex-column"> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#datazen">datazen</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#optional-arguments">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#commands">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#grip">grip</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id2">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pypi">pypi</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id3">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id4">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#python">python</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id5">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id6">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#venv">venv</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id7">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id8">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#vmklib">vmklib</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id9">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#yaml">yaml</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id10">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id11">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#internal-dependency-graph">Internal Dependency Graph</a></li> | ||
| </ul> | ||
| </nav> | ||
| </div> | ||
@@ -326,7 +381,240 @@ </div> | ||
| <section id="vmklib"> | ||
| <h1>vmklib<a class="headerlink" href="#vmklib" title="Link to this heading">#</a></h1> | ||
| <!-- | ||
| ===================================== | ||
| generator=datazen | ||
| version=3.2.3 | ||
| hash=840dae6ff36d11c17a8245212897c333 | ||
| ===================================== | ||
| --> | ||
| <section id="vmklib-2-0-12"> | ||
| <h1>vmklib (<a class="reference external" href="https://pypi.org/project/vmklib/">2.0.12</a>)<a class="headerlink" href="#vmklib-2-0-12" title="Link to this heading">#</a></h1> | ||
| <p><a class="reference external" href="https://pypi.org/project/vmklib/"><img alt="python" src="https://img.shields.io/pypi/pyversions/vmklib.svg" /></a> | ||
| <img alt="Build Status" src="https://github.com/libre-embedded/vmklib/workflows/Python%20Package/badge.svg" /> | ||
| <a class="reference external" href="https://codecov.io/github/libre-embedded/vmklib"><img alt="codecov" src="https://codecov.io/gh/libre-embedded/vmklib/branch/master/graphs/badge.svg?branch=master" /></a> | ||
| <img alt="PyPI - Status" src="https://img.shields.io/pypi/status/vmklib" /> | ||
| <img alt="Dependents (via libraries.io)" src="https://img.shields.io/librariesio/dependents/pypi/vmklib" /></p> | ||
| <p><em>Simplify project workflows by standardizing use of GNU Make.</em></p> | ||
| <p>Consider <a class="reference external" href="https://github.com/sponsors/libre-embedded">sponsoring development</a>.</p> | ||
| <p>(<a class="reference external" href="https://libre-embedded.github.io/python/vmklib">interface documentation</a>)</p> | ||
| <section id="python-version-support"> | ||
| <h2>Python Version Support<a class="headerlink" href="#python-version-support" title="Link to this heading">#</a></h2> | ||
| <p>This package is tested with the following Python minor versions:</p> | ||
| <ul class="simple"> | ||
| <li><p><a class="reference external" href="https://docs.python.org/3.13/"><code class="docutils literal notranslate"><span class="pre">python3.13</span></code></a></p></li> | ||
| <li><p><a class="reference external" href="https://docs.python.org/3.14/"><code class="docutils literal notranslate"><span class="pre">python3.14</span></code></a></p></li> | ||
| </ul> | ||
| </section> | ||
| <section id="platform-support"> | ||
| <h2>Platform Support<a class="headerlink" href="#platform-support" title="Link to this heading">#</a></h2> | ||
| <p>This package is tested on the following platforms:</p> | ||
| <ul class="simple"> | ||
| <li><p><code class="docutils literal notranslate"><span class="pre">ubuntu-latest</span></code></p></li> | ||
| <li><p><code class="docutils literal notranslate"><span class="pre">macos-latest</span></code></p></li> | ||
| <li><p><code class="docutils literal notranslate"><span class="pre">windows-latest</span></code></p></li> | ||
| </ul> | ||
| </section> | ||
| </section> | ||
| <section id="introduction"> | ||
| <h1>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">#</a></h1> | ||
| <p>This tool integrates with existing <code class="docutils literal notranslate"><span class="pre">Makefile</span></code>’s with zero additional | ||
| content or bootstrapping required.</p> | ||
| <p>There are many choices in technology or products for performing static | ||
| analysis on source code, building test infrastructure, or managing local | ||
| development environments. These are only a small subset of common, developer | ||
| tasks when building software. This package intends to aggregate recipes | ||
| (and their dependency relationships) for these tasks so that they can be | ||
| integrated into a project without re-building this infrastructure. Lessons | ||
| learned and improvements in each project can be back-propagated everywhere | ||
| else with simple package updates.</p> | ||
| </section> | ||
| <section id="command-line-options"> | ||
| <h1>Command-line Options<a class="headerlink" href="#command-line-options" title="Link to this heading">#</a></h1> | ||
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./venv3.14/bin/mk -h | ||
| usage: mk [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR] | ||
| [-p PREFIX] [-d] [-D DEFAULT] [-f FILE] [-c CONFIG] [-P PROJ] | ||
| [targets ...] | ||
| Simplify project workflows by standardizing use of GNU Make. | ||
| positional arguments: | ||
| targets targets to execute | ||
| options: | ||
| -h, --help show this help message and exit | ||
| --version show program's version number and exit | ||
| -v, --verbose set to increase logging verbosity | ||
| -q, --quiet set to reduce output | ||
| --curses whether or not to use curses.wrapper when starting | ||
| --no-uvloop whether or not to disable uvloop as event loop driver | ||
| -C, --dir DIR execute from a specific directory | ||
| -p, --prefix PREFIX a prefix to apply to all targets | ||
| -d, --disable-make whether or not to allow GNU Make target resolution | ||
| (default: 'False') | ||
| -D, --default DEFAULT | ||
| default target to make if none is specified (default: | ||
| 'all') | ||
| -f, --file FILE file to source user-provided recipes from (default: | ||
| 'Makefile') | ||
| -c, --config CONFIG file to source user-provided variable definitions, | ||
| ahead of loading package makefiles (default: | ||
| 'vmklib.json') | ||
| -P, --proj PROJ project name for internal variable use | ||
| </pre></div> | ||
| </div> | ||
| </section> | ||
| <section id="targets"> | ||
| <h1>Targets<a class="headerlink" href="#targets" title="Link to this heading">#</a></h1> | ||
| <p>Note that the full invocation for a target’s command is:</p> | ||
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mk</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="o"><</span><span class="n">prefix</span><span class="o">>-<</span><span class="n">command</span><span class="o">></span> <span class="p">[</span><span class="n">ARG1</span><span class="o">=</span><span class="n">val1</span> <span class="n">ARG2</span><span class="o">=</span><span class="n">val2</span><span class="p">]</span> | ||
| </pre></div> | ||
| </div> | ||
| <section id="datazen"> | ||
| <h2>datazen<a class="headerlink" href="#datazen" title="Link to this heading">#</a></h2> | ||
| <p>Targets for use with the <a class="reference external" href="https://pypi.org/project/datazen/">datazen</a> package.</p> | ||
| <p>Prefix: <code class="docutils literal notranslate"><span class="pre">dz-</span></code></p> | ||
| <section id="optional-arguments"> | ||
| <h3>Optional Arguments<a class="headerlink" href="#optional-arguments" title="Link to this heading">#</a></h3> | ||
| <p><strong>DZ_DIR</strong> - Optionally override the <code class="docutils literal notranslate"><span class="pre">-C</span></code> argument.</p> | ||
| <p><strong>DZ_MANIFEST</strong> - Optionally provide a non-default manifest file to <code class="docutils literal notranslate"><span class="pre">-m</span></code>.</p> | ||
| <p><strong>DZ_VERBOSE</strong> - Setting this passes <code class="docutils literal notranslate"><span class="pre">-v</span></code> as an additional argument.</p> | ||
| </section> | ||
| <section id="commands"> | ||
| <h3>Commands<a class="headerlink" href="#commands" title="Link to this heading">#</a></h3> | ||
| <p><strong>sync</strong> - Run <code class="docutils literal notranslate"><span class="pre">dz</span></code>, executing the default target.</p> | ||
| <p><strong>clean</strong> - Run <code class="docutils literal notranslate"><span class="pre">dz</span></code> with <code class="docutils literal notranslate"><span class="pre">-c</span></code> to clean the cache.</p> | ||
| <p><strong>describe</strong> - Run <code class="docutils literal notranslate"><span class="pre">dz</span></code> with <code class="docutils literal notranslate"><span class="pre">-d</span></code> to describe cache contents.</p> | ||
| <p><strong>install</strong> - Install <code class="docutils literal notranslate"><span class="pre">datazen</span></code> in the resolved virtual environment (with <code class="docutils literal notranslate"><span class="pre">pip</span></code>). This depends on a “concrete” underlying target that allows it to be installed only once.</p> | ||
| <p><strong>upgrade</strong> - Upgrade <code class="docutils literal notranslate"><span class="pre">datazen</span></code> in the resolved virtual environment (with <code class="docutils literal notranslate"><span class="pre">pip</span></code>).</p> | ||
| </section> | ||
| </section> | ||
| <section id="grip"> | ||
| <h2>grip<a class="headerlink" href="#grip" title="Link to this heading">#</a></h2> | ||
| <p>Targets for rendering <a class="reference external" href="https://docs.github.com/en/rest/reference/markdown">GitHub Markdown</a> with <a class="reference external" href="https://github.com/joeyespo/grip">grip</a>.</p> | ||
| <p>Prefix: <code class="docutils literal notranslate"><span class="pre">grip-</span></code></p> | ||
| <section id="id1"> | ||
| <h3>Optional Arguments<a class="headerlink" href="#id1" title="Link to this heading">#</a></h3> | ||
| <p><strong>SECRETHUB_GRIP_PATH</strong> - The full path for the <code class="docutils literal notranslate"><span class="pre">secrethub</span> <span class="pre">read</span></code> command to source a <a class="reference external" href="https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token">GitHub personal access token</a> from, requires <a class="reference external" href="https://secrethub.io/">secrethub</a>.</p> | ||
| <p><strong>GRIP_PORT</strong> - The <code class="docutils literal notranslate"><span class="pre">host:port</span></code> String to serve the rendered results on.</p> | ||
| <p><strong>GRIP_ENV</strong> - Output file to write to for sourcing credentials.</p> | ||
| <p><strong>GRIP_FILE</strong> - The file to render, path is relative to project root.</p> | ||
| </section> | ||
| <section id="id2"> | ||
| <h3>Commands<a class="headerlink" href="#id2" title="Link to this heading">#</a></h3> | ||
| <p><strong>check-env</strong> - Checks that <code class="docutils literal notranslate"><span class="pre">GRIP_TOKEN</span></code> is set in the environment, errors if not.</p> | ||
| <p><strong>render</strong> - Serve <code class="docutils literal notranslate"><span class="pre">README.md</span></code> with <code class="docutils literal notranslate"><span class="pre">grip</span></code>.</p> | ||
| </section> | ||
| </section> | ||
| <section id="pypi"> | ||
| <h2>pypi<a class="headerlink" href="#pypi" title="Link to this heading">#</a></h2> | ||
| <p>Targets for uploading packages to <a class="reference external" href="https://pypi.org/">PyPI</a>.</p> | ||
| <p>Prefix: <code class="docutils literal notranslate"><span class="pre">pypi-</span></code></p> | ||
| <section id="id3"> | ||
| <h3>Optional Arguments<a class="headerlink" href="#id3" title="Link to this heading">#</a></h3> | ||
| <p><strong>UPLOAD_ENV</strong> - Output file to write to for sourcing credentials.</p> | ||
| <p><strong>SECRETHUB_PYPI_PATH</strong> - The full path for the <code class="docutils literal notranslate"><span class="pre">secrethub</span> <span class="pre">read</span></code> command to source a <a class="reference external" href="https://pypi.org/help/#apitoken">PyPI API token</a> from, requires <a class="reference external" href="https://secrethub.io/">secrethub</a>.</p> | ||
| </section> | ||
| <section id="id4"> | ||
| <h3>Commands<a class="headerlink" href="#id4" title="Link to this heading">#</a></h3> | ||
| <p><strong>check-env</strong> - Enforces that <code class="docutils literal notranslate"><span class="pre">TWINE_USERNAME</span></code> and <code class="docutils literal notranslate"><span class="pre">TWINE_PASSWORD</span></code> are set in the environment, errors if not.</p> | ||
| <p><strong>upload</strong> - Attempt to upload everything in <code class="docutils literal notranslate"><span class="pre">dist</span></code> to <a class="reference external" href="https://pypi.org/">PyPI</a>.</p> | ||
| </section> | ||
| </section> | ||
| <section id="python"> | ||
| <h2>python<a class="headerlink" href="#python" title="Link to this heading">#</a></h2> | ||
| <p>Targets for executing common, <a class="reference external" href="https://www.python.org/">Python</a> workflow tasks.</p> | ||
| <p>Prefix: <code class="docutils literal notranslate"><span class="pre">python-</span></code></p> | ||
| <section id="id5"> | ||
| <h3>Optional Arguments<a class="headerlink" href="#id5" title="Link to this heading">#</a></h3> | ||
| <p><strong>PY_LINT_ARGS</strong> - Set to override the default, adds the <code class="docutils literal notranslate"><span class="pre">tests</span></code> directory and <code class="docutils literal notranslate"><span class="pre">PY_LINT_EXTRA_ARGS</span></code>.</p> | ||
| <p><strong>PY_WIDTH</strong> - Override (from <code class="docutils literal notranslate"><span class="pre">79</span></code>) to set <code class="docutils literal notranslate"><span class="pre">--line-length</span></code> arguments for formatters.</p> | ||
| <p><strong>PY_LINT_EXTRA_ARGS</strong> - Set to add additional linting arguments.</p> | ||
| <p><strong>PYTEST_ARGS</strong> - Set to override the default, additional <a class="reference external" href="https://docs.pytest.org/en/stable/">pytest</a> arguments.</p> | ||
| <p><strong>PYTEST_EXTRA_ARGS</strong> - Add additional arguments to the default set.</p> | ||
| <p><strong>PYTHON_COV_PORT</strong> - Port to host test-coverage HTML on (using <code class="docutils literal notranslate"><span class="pre">http.server</span></code>). Defaults to zero.</p> | ||
| <p><strong>PY_BUILDER</strong> - The target name to use as a <code class="docutils literal notranslate"><span class="pre">python-upload</span></code> dependency (e.g. <code class="docutils literal notranslate"><span class="pre">python-dist</span></code> versus <code class="docutils literal notranslate"><span class="pre">python-build</span></code>). Defaults to <code class="docutils literal notranslate"><span class="pre">python-build</span></code>.</p> | ||
| <p><strong>PY_DOCS_HOST</strong> - Host argument passed to <code class="docutils literal notranslate"><span class="pre">pydoc</span></code> module (<code class="docutils literal notranslate"><span class="pre">-n</span></code>). Defaults to <code class="docutils literal notranslate"><span class="pre">0.0.0.0</span></code>.</p> | ||
| <p><strong>PY_DOCS_PORT</strong> - Port argument passed to <code class="docutils literal notranslate"><span class="pre">pydoc</span></code> module (<code class="docutils literal notranslate"><span class="pre">-p</span></code>). Defaults to <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p> | ||
| <p><strong>PY_DOCS_EXTRA_ARGS</strong> - Extra arguments to pass to the <code class="docutils literal notranslate"><span class="pre">pydoc</span></code> module.</p> | ||
| </section> | ||
| <section id="id6"> | ||
| <h3>Commands<a class="headerlink" href="#id6" title="Link to this heading">#</a></h3> | ||
| <p><strong>lint</strong> - Run <a class="reference external" href="https://www.pylint.org/">pylint</a> and <a class="reference external" href="https://flake8.pycqa.org/en/latest/">flake8</a> against a project’s package sources. Also runs the format checkers.</p> | ||
| <p><strong>sa</strong> - Run <a class="reference external" href="http://mypy-lang.org/">mypy</a> against a project’s package sources.</p> | ||
| <p><strong>sa-types</strong> - Run <a class="reference external" href="http://mypy-lang.org/">mypy</a> without checking the result and attempt to install missing type/stub packages.</p> | ||
| <p><strong>stubs</strong> - Run <a class="reference external" href="https://mypy.readthedocs.io/en/stable/stubgen.html">stubgen</a> against a project’s package sources.</p> | ||
| <p><strong>format</strong> - Run <a class="reference external" href="https://pypi.org/project/black/">black</a> and <a class="reference external" href="https://pypi.org/project/isort/">isort</a> against a project’s package sources.</p> | ||
| <p><strong>format-check</strong> - Run <a class="reference external" href="https://pypi.org/project/black/">black</a> with the <code class="docutils literal notranslate"><span class="pre">--check</span></code> argument and <a class="reference external" href="https://pypi.org/project/isort/">isort</a> with the <code class="docutils literal notranslate"><span class="pre">--check-only</span></code> argument.</p> | ||
| <p><strong>tags</strong> - Create a <code class="docutils literal notranslate"><span class="pre">tags</span></code> file for the project using <a class="reference external" href="https://github.com/universal-ctags/ctags">ctags</a> (must be installed).</p> | ||
| <p><strong>edit</strong> - Create <code class="docutils literal notranslate"><span class="pre">tags</span></code> and then open $EDITOR in the project directory.</p> | ||
| <p><strong>test</strong> - Run all of a project’s tests with <a class="reference external" href="https://docs.pytest.org/en/stable/">pytest</a>.</p> | ||
| <p><strong>test-%</strong> - Run project tests based on a search pattern (i.e. the <code class="docutils literal notranslate"><span class="pre">-k</span></code> option).</p> | ||
| <p><strong>view</strong> - Attempt to open the test-coverage HTML with <code class="docutils literal notranslate"><span class="pre">$BROWSER</span></code> (environment variable).</p> | ||
| <p><strong>host-coverage</strong> - Host test-coverage HTML locally, with the port specified by <code class="docutils literal notranslate"><span class="pre">PYTHON_COV_PORT</span></code>.</p> | ||
| <p><strong>all</strong> - Run <code class="docutils literal notranslate"><span class="pre">lint</span></code>, <code class="docutils literal notranslate"><span class="pre">sa</span></code> and <code class="docutils literal notranslate"><span class="pre">test</span></code> in sequence.</p> | ||
| <p><strong>clean</strong> - Remove compiled and cached files, test coverage, built package artifacts and other caches.</p> | ||
| <p><strong>dist</strong> - Build <code class="docutils literal notranslate"><span class="pre">sdist</span></code> and <code class="docutils literal notranslate"><span class="pre">bdist_wheel</span></code> with <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> in the project root.</p> | ||
| <p><strong>build</strong> - Build the package with <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">build</span></code>.</p> | ||
| <p><strong>dist-with-stubs</strong> - Build <code class="docutils literal notranslate"><span class="pre">sdist</span></code> and <code class="docutils literal notranslate"><span class="pre">bdist_wheel</span></code> with <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> in the project root, this also runs <code class="docutils literal notranslate"><span class="pre">stubgen</span></code> ahead of packaging so that stubs are included in the source distribution and wheel.</p> | ||
| <p><strong>upload</strong> - Use <a class="reference external" href="https://pypi.org/project/twine/">twine</a> to upload the built package to <a class="reference external" href="https://pypi.org/">PyPI</a>.</p> | ||
| <p><strong>editable</strong> - Install the project’s package in editable mode (<code class="docutils literal notranslate"><span class="pre">-e</span></code> option) to the virtual environment.</p> | ||
| <p><strong>docs</strong> - Run the <code class="docutils literal notranslate"><span class="pre">pydoc</span></code> module and host HTML documentation via an arbitrary HTTP port.</p> | ||
| <p><strong>docs-%</strong> - Run the <code class="docutils literal notranslate"><span class="pre">pydoc</span></code> module and pass the stem as an argument.</p> | ||
| <p><strong>deps</strong> - Run <code class="docutils literal notranslate"><span class="pre">pydeps</span></code> against the project (producing <a class="reference external" href="https://www.w3.org/TR/SVG2/">SVG</a> output).</p> | ||
| </section> | ||
| </section> | ||
| <section id="venv"> | ||
| <h2>venv<a class="headerlink" href="#venv" title="Link to this heading">#</a></h2> | ||
| <p>Targets for managing <a class="reference external" href="https://docs.python.org/3/library/venv.html">Python virtual environments</a>.</p> | ||
| <p>Prefix: <code class="docutils literal notranslate"><span class="pre">(no</span> <span class="pre">prefix)</span></code></p> | ||
| <section id="id7"> | ||
| <h3>Optional Arguments<a class="headerlink" href="#id7" title="Link to this heading">#</a></h3> | ||
| <p><strong>PYTHON_VERSION</strong> - The version of Python to create a virtual environment for. (default: <code class="docutils literal notranslate"><span class="pre">3.8</span></code>)</p> | ||
| <p><strong>REQUIREMENTS_DIR</strong> - The location of the directory containing requirements files. (default: <code class="docutils literal notranslate"><span class="pre">requirements</span></code> in the project root)</p> | ||
| <p><strong>REQ_FILES</strong> - Text files to install requirements from (using <code class="docutils literal notranslate"><span class="pre">-r</span></code>), in the requirements directory. (default: <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code> and <code class="docutils literal notranslate"><span class="pre">dev_requirements.txt</span></code>)</p> | ||
| </section> | ||
| <section id="id8"> | ||
| <h3>Commands<a class="headerlink" href="#id8" title="Link to this heading">#</a></h3> | ||
| <p><strong>venv</strong> - Create or update the resolved virtual environment, if necessary.</p> | ||
| <p><strong>venv-clean</strong> - Remove any virtual environments from the project root (or sub-directories).</p> | ||
| </section> | ||
| </section> | ||
| <section id="vmklib"> | ||
| <h2>vmklib<a class="headerlink" href="#vmklib" title="Link to this heading">#</a></h2> | ||
| <p>Targets related to this package, itself.</p> | ||
| <p>Prefix: <code class="docutils literal notranslate"><span class="pre">mk-</span></code></p> | ||
| <section id="id9"> | ||
| <h3>Commands<a class="headerlink" href="#id9" title="Link to this heading">#</a></h3> | ||
| <p><strong>upgrade</strong> - Upgrade (or install) <code class="docutils literal notranslate"><span class="pre">vmklib</span></code> in the resolved virtual environment.</p> | ||
| <p><strong>sys-upgrade</strong> - Upgrade (or install) <code class="docutils literal notranslate"><span class="pre">vmklib</span></code> as a system or user package.</p> | ||
| <p><strong>header</strong> - Print the <code class="docutils literal notranslate"><span class="pre">Makefile</span></code> header that should be used when integrating this package.</p> | ||
| <p><strong>todo</strong> - Perform a case-insensitive search for <code class="docutils literal notranslate"><span class="pre">todo</span></code> in project directories.</p> | ||
| </section> | ||
| </section> | ||
| <section id="yaml"> | ||
| <h2>yaml<a class="headerlink" href="#yaml" title="Link to this heading">#</a></h2> | ||
| <p>Targets for interacting with <a class="reference external" href="https://yaml.org/">yaml</a> data (files).</p> | ||
| <p>Prefix: <code class="docutils literal notranslate"><span class="pre">yaml-</span></code></p> | ||
| <section id="id10"> | ||
| <h3>Optional Arguments<a class="headerlink" href="#id10" title="Link to this heading">#</a></h3> | ||
| <p><strong>YAMLLINT_ARGS</strong> - Set to provide arguments to <code class="docutils literal notranslate"><span class="pre">yamllint</span></code> (such as the path to a config file).</p> | ||
| </section> | ||
| <section id="id11"> | ||
| <h3>Commands<a class="headerlink" href="#id11" title="Link to this heading">#</a></h3> | ||
| <p><strong>yaml-lint-install</strong> - Install <a class="reference external" href="https://yamllint.readthedocs.io/en/stable/index.html">yamllint</a>.</p> | ||
| <p><strong>yaml-lint-%</strong> - Execute <code class="docutils literal notranslate"><span class="pre">yamllint</span></code> against <code class="docutils literal notranslate"><span class="pre">$*</span></code>.</p> | ||
| </section> | ||
| </section> | ||
| </section> | ||
| <section id="internal-dependency-graph"> | ||
| <h1>Internal Dependency Graph<a class="headerlink" href="#internal-dependency-graph" title="Link to this heading">#</a></h1> | ||
| <p>A coarse view of the internal structure and scale of | ||
| <code class="docutils literal notranslate"><span class="pre">vmklib</span></code>’s source. | ||
| Generated using <a class="reference external" href="https://github.com/thebjorn/pydeps">pydeps</a> (via | ||
| <code class="docutils literal notranslate"><span class="pre">mk</span> <span class="pre">python-deps</span></code>).</p> | ||
| <p><img alt="vmklib's Dependency Graph" src="_images/pydeps.svg" /></p> | ||
| </section> | ||
| <div class="toctree-wrapper compound"> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Interface Documentation</span></p> | ||
| <ul> | ||
@@ -371,3 +659,2 @@ <li class="toctree-l1"><a class="reference internal" href="vmklib.html">vmklib package</a><ul> | ||
| </div> | ||
| </section> | ||
@@ -401,2 +688,62 @@ | ||
| <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner"> | ||
| <div class="sidebar-secondary-item"> | ||
| <div class="page-toc tocsection onthispage"> | ||
| <i class="fa-solid fa-list"></i> Contents | ||
| </div> | ||
| <nav class="bd-toc-nav page-toc"> | ||
| <ul class="visible nav section-nav flex-column"> | ||
| <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">vmklib (2.0.12)</a><ul class="visible nav section-nav flex-column"> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#python-version-support">Python Version Support</a></li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#platform-support">Platform Support</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#introduction">Introduction</a></li> | ||
| <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#command-line-options">Command-line Options</a></li> | ||
| <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#targets">Targets</a><ul class="visible nav section-nav flex-column"> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#datazen">datazen</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#optional-arguments">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#commands">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#grip">grip</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id2">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pypi">pypi</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id3">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id4">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#python">python</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id5">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id6">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#venv">venv</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id7">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id8">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#vmklib">vmklib</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id9">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#yaml">yaml</a><ul class="nav section-nav flex-column"> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id10">Optional Arguments</a></li> | ||
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id11">Commands</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#internal-dependency-graph">Internal Dependency Graph</a></li> | ||
| </ul> | ||
| </nav></div> | ||
| </div></div> | ||
@@ -403,0 +750,0 @@ </div> |
@@ -38,3 +38,3 @@ | ||
| <script src="_static/documentation_options.js?v=55d7fe76"></script> | ||
| <script src="_static/documentation_options.js?v=96e9dbe8"></script> | ||
| <script src="_static/doctools.js?v=fd6eb6e6"></script> | ||
@@ -161,3 +161,3 @@ <script src="_static/sphinx_highlight.js?v=6ffebe34"></script> | ||
| <div class="bd-toc-item navbar-nav active"> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Interface Documentation</span></p> | ||
| <ul class="nav bd-sidenav"> | ||
@@ -164,0 +164,0 @@ <li class="toctree-l1 has-children"><a class="reference internal" href="vmklib.html">vmklib package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
@@ -37,3 +37,3 @@ | ||
| <script src="_static/documentation_options.js?v=55d7fe76"></script> | ||
| <script src="_static/documentation_options.js?v=96e9dbe8"></script> | ||
| <script src="_static/doctools.js?v=fd6eb6e6"></script> | ||
@@ -160,3 +160,3 @@ <script src="_static/sphinx_highlight.js?v=6ffebe34"></script> | ||
| <div class="bd-toc-item navbar-nav active"> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Interface Documentation</span></p> | ||
| <ul class="nav bd-sidenav"> | ||
@@ -163,0 +163,0 @@ <li class="toctree-l1 has-children"><a class="reference internal" href="vmklib.html">vmklib package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> |
@@ -1,1 +0,1 @@ | ||
| Search.setIndex({"alltitles":{"Contents:":[[0,null]],"Module contents":[[1,"module-vmklib"],[2,"module-vmklib.tasks"],[3,"module-vmklib.tasks.mixins"],[4,"module-vmklib.tasks.node"],[5,"module-vmklib.tasks.python"]],"Submodules":[[1,"submodules"],[2,"submodules"],[3,"submodules"],[5,"submodules"]],"Subpackages":[[1,"subpackages"],[2,"subpackages"]],"vmklib":[[0,null]],"vmklib package":[[1,null]],"vmklib.app module":[[1,"module-vmklib.app"]],"vmklib.entry module":[[1,"module-vmklib.entry"]],"vmklib.tasks package":[[2,null]],"vmklib.tasks.args module":[[2,"module-vmklib.tasks.args"]],"vmklib.tasks.clean module":[[2,"module-vmklib.tasks.clean"]],"vmklib.tasks.github module":[[2,"module-vmklib.tasks.github"]],"vmklib.tasks.mixins package":[[3,null]],"vmklib.tasks.mixins.concrete module":[[3,"module-vmklib.tasks.mixins.concrete"]],"vmklib.tasks.mixins.curl module":[[3,"module-vmklib.tasks.mixins.curl"]],"vmklib.tasks.node package":[[4,null]],"vmklib.tasks.python package":[[5,null]],"vmklib.tasks.python.build module":[[5,"module-vmklib.tasks.python.build"]],"vmklib.tasks.python.datazen module":[[5,"module-vmklib.tasks.python.datazen"]],"vmklib.tasks.python.docs module":[[5,"module-vmklib.tasks.python.docs"]],"vmklib.tasks.python.lint module":[[5,"module-vmklib.tasks.python.lint"]],"vmklib.tasks.python.package module":[[5,"module-vmklib.tasks.python.package"]],"vmklib.tasks.python.release module":[[5,"module-vmklib.tasks.python.release"]],"vmklib.tasks.python.sa module":[[5,"module-vmklib.tasks.python.sa"]],"vmklib.tasks.python.test module":[[5,"module-vmklib.tasks.python.test"]],"vmklib.tasks.python.yaml module":[[5,"module-vmklib.tasks.python.yaml"]],"vmklib.tasks.release module":[[2,"module-vmklib.tasks.release"]],"vmklib.tasks.venv module":[[2,"module-vmklib.tasks.venv"]],"vmklib.util module":[[1,"module-vmklib.util"]]},"docnames":["index","vmklib","vmklib.tasks","vmklib.tasks.mixins","vmklib.tasks.node","vmklib.tasks.python"],"envversion":{"sphinx":66,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1},"filenames":["index.rst","vmklib.rst","vmklib.tasks.rst","vmklib.tasks.mixins.rst","vmklib.tasks.node.rst","vmklib.tasks.python.rst"],"indexentries":{"add_app_args() (in module vmklib.app)":[[1,"vmklib.app.add_app_args",false]],"build_dir() (vmklib.tasks.vmklibbase class method)":[[2,"vmklib.tasks.VmklibBase.build_dir",false]],"build_makefile() (in module vmklib.app)":[[1,"vmklib.app.build_makefile",false]],"clean (class in vmklib.tasks.clean)":[[2,"vmklib.tasks.clean.Clean",false]],"code (vmklib.tasks.mixins.commandresult attribute)":[[3,"vmklib.tasks.mixins.CommandResult.code",false]],"code (vmklib.tasks.mixins.curl.commandresult attribute)":[[3,"vmklib.tasks.mixins.curl.CommandResult.code",false]],"commandresult (class in vmklib.tasks.mixins)":[[3,"vmklib.tasks.mixins.CommandResult",false]],"commandresult (class in vmklib.tasks.mixins.curl)":[[3,"vmklib.tasks.mixins.curl.CommandResult",false]],"concrete_path() (vmklib.tasks.mixins.concrete.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin.concrete_path",false]],"concrete_path() (vmklib.tasks.mixins.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.ConcreteBuilderMixin.concrete_path",false]],"concretebuildermixin (class in vmklib.tasks.mixins)":[[3,"vmklib.tasks.mixins.ConcreteBuilderMixin",false]],"concretebuildermixin (class in vmklib.tasks.mixins.concrete)":[[3,"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin",false]],"concreteoncemixin (class in vmklib.tasks.mixins)":[[3,"vmklib.tasks.mixins.ConcreteOnceMixin",false]],"concreteoncemixin (class in vmklib.tasks.mixins.concrete)":[[3,"vmklib.tasks.mixins.concrete.ConcreteOnceMixin",false]],"create_release() (vmklib.tasks.release.githubrelease method)":[[2,"vmklib.tasks.release.GithubRelease.create_release",false]],"curl() (vmklib.tasks.mixins.curl.curlmixin method)":[[3,"vmklib.tasks.mixins.curl.CurlMixin.curl",false]],"curl() (vmklib.tasks.mixins.curlmixin method)":[[3,"vmklib.tasks.mixins.CurlMixin.curl",false]],"curl_headers() (in module vmklib.tasks.mixins)":[[3,"vmklib.tasks.mixins.curl_headers",false]],"curl_headers() (in module vmklib.tasks.mixins.curl)":[[3,"vmklib.tasks.mixins.curl.curl_headers",false]],"curlmixin (class in vmklib.tasks.mixins)":[[3,"vmklib.tasks.mixins.CurlMixin",false]],"curlmixin (class in vmklib.tasks.mixins.curl)":[[3,"vmklib.tasks.mixins.curl.CurlMixin",false]],"datazentask (class in vmklib.tasks.python.datazen)":[[5,"vmklib.tasks.python.datazen.DatazenTask",false]],"default_requirements (vmklib.tasks.python.datazen.datazentask attribute)":[[5,"vmklib.tasks.python.datazen.DatazenTask.default_requirements",false]],"default_requirements (vmklib.tasks.python.docs.pydepstask attribute)":[[5,"vmklib.tasks.python.docs.PydepsTask.default_requirements",false]],"default_requirements (vmklib.tasks.python.lint.pythonlinter attribute)":[[5,"vmklib.tasks.python.lint.PythonLinter.default_requirements",false]],"default_requirements (vmklib.tasks.python.package.pythonpackage attribute)":[[5,"vmklib.tasks.python.package.PythonPackage.default_requirements",false]],"default_requirements (vmklib.tasks.python.test.pythontester attribute)":[[5,"vmklib.tasks.python.test.PythonTester.default_requirements",false]],"default_requirements (vmklib.tasks.python.yaml.yamllint attribute)":[[5,"vmklib.tasks.python.yaml.Yamllint.default_requirements",false]],"default_requirements (vmklib.tasks.vmklibbase attribute)":[[2,"vmklib.tasks.VmklibBase.default_requirements",false]],"ensure_api_token() (in module vmklib.tasks.github)":[[2,"vmklib.tasks.github.ensure_api_token",false]],"entry() (in module vmklib.app)":[[1,"vmklib.app.entry",false]],"environ_fallback() (in module vmklib.tasks.args)":[[2,"vmklib.tasks.args.environ_fallback",false]],"environ_fallback_split() (in module vmklib.tasks.args)":[[2,"vmklib.tasks.args.environ_fallback_split",false]],"get_data() (in module vmklib.app)":[[1,"vmklib.app.get_data",false]],"githubrelease (class in vmklib.tasks.release)":[[2,"vmklib.tasks.release.GithubRelease",false]],"initialize_task_manager() (in module vmklib.app)":[[1,"vmklib.app.initialize_task_manager",false]],"is_concrete_stale() (vmklib.tasks.mixins.concrete.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin.is_concrete_stale",false]],"is_concrete_stale() (vmklib.tasks.mixins.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.ConcreteBuilderMixin.is_concrete_stale",false]],"linter_args (vmklib.tasks.python.lint.pythonlinter attribute)":[[5,"vmklib.tasks.python.lint.PythonLinter.linter_args",false]],"main() (in module vmklib.entry)":[[1,"vmklib.entry.main",false]],"module":[[1,"module-vmklib",false],[1,"module-vmklib.app",false],[1,"module-vmklib.entry",false],[1,"module-vmklib.util",false],[2,"module-vmklib.tasks",false],[2,"module-vmklib.tasks.args",false],[2,"module-vmklib.tasks.clean",false],[2,"module-vmklib.tasks.github",false],[2,"module-vmklib.tasks.release",false],[2,"module-vmklib.tasks.venv",false],[3,"module-vmklib.tasks.mixins",false],[3,"module-vmklib.tasks.mixins.concrete",false],[3,"module-vmklib.tasks.mixins.curl",false],[4,"module-vmklib.tasks.node",false],[5,"module-vmklib.tasks.python",false],[5,"module-vmklib.tasks.python.build",false],[5,"module-vmklib.tasks.python.datazen",false],[5,"module-vmklib.tasks.python.docs",false],[5,"module-vmklib.tasks.python.lint",false],[5,"module-vmklib.tasks.python.package",false],[5,"module-vmklib.tasks.python.release",false],[5,"module-vmklib.tasks.python.sa",false],[5,"module-vmklib.tasks.python.test",false],[5,"module-vmklib.tasks.python.yaml",false]],"npx (class in vmklib.tasks.node)":[[4,"vmklib.tasks.node.Npx",false]],"project() (in module vmklib.app)":[[1,"vmklib.app.project",false]],"pydepstask (class in vmklib.tasks.python.docs)":[[5,"vmklib.tasks.python.docs.PydepsTask",false]],"python_entry() (in module vmklib.tasks.python)":[[5,"vmklib.tasks.python.python_entry",false]],"python_version() (in module vmklib.tasks.python)":[[5,"vmklib.tasks.python.python_version",false]],"pythonbuild (class in vmklib.tasks.python.build)":[[5,"vmklib.tasks.python.build.PythonBuild",false]],"pythonlinter (class in vmklib.tasks.python.lint)":[[5,"vmklib.tasks.python.lint.PythonLinter",false]],"pythonpackage (class in vmklib.tasks.python.package)":[[5,"vmklib.tasks.python.package.PythonPackage",false]],"pythontester (class in vmklib.tasks.python.test)":[[5,"vmklib.tasks.python.test.PythonTester",false]],"register() (in module vmklib.tasks.node)":[[4,"vmklib.tasks.node.register",false]],"register() (in module vmklib.tasks.python.build)":[[5,"vmklib.tasks.python.build.register",false]],"register() (in module vmklib.tasks.python.datazen)":[[5,"vmklib.tasks.python.datazen.register",false]],"register() (in module vmklib.tasks.python.docs)":[[5,"vmklib.tasks.python.docs.register",false]],"register() (in module vmklib.tasks.python.lint)":[[5,"vmklib.tasks.python.lint.register",false]],"register() (in module vmklib.tasks.python.package)":[[5,"vmklib.tasks.python.package.register",false]],"register() (in module vmklib.tasks.python.release)":[[5,"vmklib.tasks.python.release.register",false]],"register() (in module vmklib.tasks.python.sa)":[[5,"vmklib.tasks.python.sa.register",false]],"register() (in module vmklib.tasks.python.test)":[[5,"vmklib.tasks.python.test.register",false]],"register() (in module vmklib.tasks.python.yaml)":[[5,"vmklib.tasks.python.yaml.register",false]],"register() (in module vmklib.tasks.venv)":[[2,"vmklib.tasks.venv.register",false]],"release() (vmklib.tasks.release.githubrelease method)":[[2,"vmklib.tasks.release.GithubRelease.release",false]],"repo_url() (in module vmklib.tasks.github)":[[2,"vmklib.tasks.github.repo_url",false]],"requirementsinstaller (class in vmklib.tasks.venv)":[[2,"vmklib.tasks.venv.RequirementsInstaller",false]],"run() (vmklib.tasks.clean.clean method)":[[2,"vmklib.tasks.clean.Clean.run",false]],"run() (vmklib.tasks.node.npx method)":[[4,"vmklib.tasks.node.Npx.run",false]],"run() (vmklib.tasks.python.build.pythonbuild method)":[[5,"vmklib.tasks.python.build.PythonBuild.run",false]],"run() (vmklib.tasks.python.datazen.datazentask method)":[[5,"vmklib.tasks.python.datazen.DatazenTask.run",false]],"run() (vmklib.tasks.python.docs.pydepstask method)":[[5,"vmklib.tasks.python.docs.PydepsTask.run",false]],"run() (vmklib.tasks.python.lint.pythonlinter method)":[[5,"vmklib.tasks.python.lint.PythonLinter.run",false]],"run() (vmklib.tasks.python.package.pythonpackage method)":[[5,"vmklib.tasks.python.package.PythonPackage.run",false]],"run() (vmklib.tasks.python.test.pythontester method)":[[5,"vmklib.tasks.python.test.PythonTester.run",false]],"run() (vmklib.tasks.python.yaml.yamllint method)":[[5,"vmklib.tasks.python.yaml.Yamllint.run",false]],"run() (vmklib.tasks.release.githubrelease method)":[[2,"vmklib.tasks.release.GithubRelease.run",false]],"run() (vmklib.tasks.venv.requirementsinstaller method)":[[2,"vmklib.tasks.venv.RequirementsInstaller.run",false]],"run() (vmklib.tasks.venv.venv method)":[[2,"vmklib.tasks.venv.Venv.run",false]],"run_enter() (vmklib.tasks.mixins.concrete.concreteoncemixin method)":[[3,"vmklib.tasks.mixins.concrete.ConcreteOnceMixin.run_enter",false]],"run_enter() (vmklib.tasks.mixins.concreteoncemixin method)":[[3,"vmklib.tasks.mixins.ConcreteOnceMixin.run_enter",false]],"run_enter() (vmklib.tasks.venv.venv method)":[[2,"vmklib.tasks.venv.Venv.run_enter",false]],"run_exit() (vmklib.tasks.mixins.concrete.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin.run_exit",false]],"run_exit() (vmklib.tasks.mixins.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.ConcreteBuilderMixin.run_exit",false]],"source_args() (vmklib.tasks.python.lint.pythonlinter static method)":[[5,"vmklib.tasks.python.lint.PythonLinter.source_args",false]],"stderr (vmklib.tasks.mixins.commandresult attribute)":[[3,"vmklib.tasks.mixins.CommandResult.stderr",false]],"stderr (vmklib.tasks.mixins.curl.commandresult attribute)":[[3,"vmklib.tasks.mixins.curl.CommandResult.stderr",false]],"stdout (vmklib.tasks.mixins.commandresult attribute)":[[3,"vmklib.tasks.mixins.CommandResult.stdout",false]],"stdout (vmklib.tasks.mixins.curl.commandresult attribute)":[[3,"vmklib.tasks.mixins.curl.CommandResult.stdout",false]],"to_slug() (in module vmklib.util)":[[1,"vmklib.util.to_slug",false]],"update_concrete() (vmklib.tasks.mixins.concrete.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin.update_concrete",false]],"update_concrete() (vmklib.tasks.mixins.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.ConcreteBuilderMixin.update_concrete",false]],"upload_release_asset() (vmklib.tasks.release.githubrelease method)":[[2,"vmklib.tasks.release.GithubRelease.upload_release_asset",false]],"venv (class in vmklib.tasks.venv)":[[2,"vmklib.tasks.venv.Venv",false]],"venv_bin() (in module vmklib.tasks.python)":[[5,"vmklib.tasks.python.venv_bin",false]],"venv_dir() (in module vmklib.tasks.python)":[[5,"vmklib.tasks.python.venv_dir",false]],"venv_name() (in module vmklib.tasks.python)":[[5,"vmklib.tasks.python.venv_name",false]],"vmklib":[[1,"module-vmklib",false]],"vmklib.app":[[1,"module-vmklib.app",false]],"vmklib.entry":[[1,"module-vmklib.entry",false]],"vmklib.tasks":[[2,"module-vmklib.tasks",false]],"vmklib.tasks.args":[[2,"module-vmklib.tasks.args",false]],"vmklib.tasks.clean":[[2,"module-vmklib.tasks.clean",false]],"vmklib.tasks.github":[[2,"module-vmklib.tasks.github",false]],"vmklib.tasks.mixins":[[3,"module-vmklib.tasks.mixins",false]],"vmklib.tasks.mixins.concrete":[[3,"module-vmklib.tasks.mixins.concrete",false]],"vmklib.tasks.mixins.curl":[[3,"module-vmklib.tasks.mixins.curl",false]],"vmklib.tasks.node":[[4,"module-vmklib.tasks.node",false]],"vmklib.tasks.python":[[5,"module-vmklib.tasks.python",false]],"vmklib.tasks.python.build":[[5,"module-vmklib.tasks.python.build",false]],"vmklib.tasks.python.datazen":[[5,"module-vmklib.tasks.python.datazen",false]],"vmklib.tasks.python.docs":[[5,"module-vmklib.tasks.python.docs",false]],"vmklib.tasks.python.lint":[[5,"module-vmklib.tasks.python.lint",false]],"vmklib.tasks.python.package":[[5,"module-vmklib.tasks.python.package",false]],"vmklib.tasks.python.release":[[5,"module-vmklib.tasks.python.release",false]],"vmklib.tasks.python.sa":[[5,"module-vmklib.tasks.python.sa",false]],"vmklib.tasks.python.test":[[5,"module-vmklib.tasks.python.test",false]],"vmklib.tasks.python.yaml":[[5,"module-vmklib.tasks.python.yaml",false]],"vmklib.tasks.release":[[2,"module-vmklib.tasks.release",false]],"vmklib.tasks.venv":[[2,"module-vmklib.tasks.venv",false]],"vmklib.util":[[1,"module-vmklib.util",false]],"vmklibbase (class in vmklib.tasks)":[[2,"vmklib.tasks.VmklibBase",false]],"yamllint (class in vmklib.tasks.python.yaml)":[[5,"vmklib.tasks.python.yaml.Yamllint",false]]},"objects":{"":[[1,0,0,"-","vmklib"]],"vmklib":[[1,0,0,"-","app"],[1,0,0,"-","entry"],[2,0,0,"-","tasks"],[1,0,0,"-","util"]],"vmklib.app":[[1,1,1,"","add_app_args"],[1,1,1,"","build_makefile"],[1,1,1,"","entry"],[1,1,1,"","get_data"],[1,1,1,"","initialize_task_manager"],[1,1,1,"","project"]],"vmklib.entry":[[1,1,1,"","main"]],"vmklib.tasks":[[2,2,1,"","VmklibBase"],[2,0,0,"-","args"],[2,0,0,"-","clean"],[2,0,0,"-","github"],[3,0,0,"-","mixins"],[4,0,0,"-","node"],[5,0,0,"-","python"],[2,0,0,"-","release"],[2,0,0,"-","venv"]],"vmklib.tasks.VmklibBase":[[2,3,1,"","build_dir"],[2,4,1,"","default_requirements"]],"vmklib.tasks.args":[[2,1,1,"","environ_fallback"],[2,1,1,"","environ_fallback_split"]],"vmklib.tasks.clean":[[2,2,1,"","Clean"]],"vmklib.tasks.clean.Clean":[[2,3,1,"","run"]],"vmklib.tasks.github":[[2,1,1,"","ensure_api_token"],[2,1,1,"","repo_url"]],"vmklib.tasks.mixins":[[3,2,1,"","CommandResult"],[3,2,1,"","ConcreteBuilderMixin"],[3,2,1,"","ConcreteOnceMixin"],[3,2,1,"","CurlMixin"],[3,0,0,"-","concrete"],[3,0,0,"-","curl"],[3,1,1,"","curl_headers"]],"vmklib.tasks.mixins.CommandResult":[[3,4,1,"","code"],[3,4,1,"","stderr"],[3,4,1,"","stdout"]],"vmklib.tasks.mixins.ConcreteBuilderMixin":[[3,3,1,"","concrete_path"],[3,3,1,"","is_concrete_stale"],[3,3,1,"","run_exit"],[3,3,1,"","update_concrete"]],"vmklib.tasks.mixins.ConcreteOnceMixin":[[3,3,1,"","run_enter"]],"vmklib.tasks.mixins.CurlMixin":[[3,3,1,"","curl"]],"vmklib.tasks.mixins.concrete":[[3,2,1,"","ConcreteBuilderMixin"],[3,2,1,"","ConcreteOnceMixin"]],"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin":[[3,3,1,"","concrete_path"],[3,3,1,"","is_concrete_stale"],[3,3,1,"","run_exit"],[3,3,1,"","update_concrete"]],"vmklib.tasks.mixins.concrete.ConcreteOnceMixin":[[3,3,1,"","run_enter"]],"vmklib.tasks.mixins.curl":[[3,2,1,"","CommandResult"],[3,2,1,"","CurlMixin"],[3,1,1,"","curl_headers"]],"vmklib.tasks.mixins.curl.CommandResult":[[3,4,1,"","code"],[3,4,1,"","stderr"],[3,4,1,"","stdout"]],"vmklib.tasks.mixins.curl.CurlMixin":[[3,3,1,"","curl"]],"vmklib.tasks.node":[[4,2,1,"","Npx"],[4,1,1,"","register"]],"vmklib.tasks.node.Npx":[[4,3,1,"","run"]],"vmklib.tasks.python":[[5,0,0,"-","build"],[5,0,0,"-","datazen"],[5,0,0,"-","docs"],[5,0,0,"-","lint"],[5,0,0,"-","package"],[5,1,1,"","python_entry"],[5,1,1,"","python_version"],[5,0,0,"-","release"],[5,0,0,"-","sa"],[5,0,0,"-","test"],[5,1,1,"","venv_bin"],[5,1,1,"","venv_dir"],[5,1,1,"","venv_name"],[5,0,0,"-","yaml"]],"vmklib.tasks.python.build":[[5,2,1,"","PythonBuild"],[5,1,1,"","register"]],"vmklib.tasks.python.build.PythonBuild":[[5,3,1,"","run"]],"vmklib.tasks.python.datazen":[[5,2,1,"","DatazenTask"],[5,1,1,"","register"]],"vmklib.tasks.python.datazen.DatazenTask":[[5,4,1,"","default_requirements"],[5,3,1,"","run"]],"vmklib.tasks.python.docs":[[5,2,1,"","PydepsTask"],[5,1,1,"","register"]],"vmklib.tasks.python.docs.PydepsTask":[[5,4,1,"","default_requirements"],[5,3,1,"","run"]],"vmklib.tasks.python.lint":[[5,2,1,"","PythonLinter"],[5,1,1,"","register"]],"vmklib.tasks.python.lint.PythonLinter":[[5,4,1,"","default_requirements"],[5,4,1,"","linter_args"],[5,3,1,"","run"],[5,3,1,"","source_args"]],"vmklib.tasks.python.package":[[5,2,1,"","PythonPackage"],[5,1,1,"","register"]],"vmklib.tasks.python.package.PythonPackage":[[5,4,1,"","default_requirements"],[5,3,1,"","run"]],"vmklib.tasks.python.release":[[5,1,1,"","register"]],"vmklib.tasks.python.sa":[[5,1,1,"","register"]],"vmklib.tasks.python.test":[[5,2,1,"","PythonTester"],[5,1,1,"","register"]],"vmklib.tasks.python.test.PythonTester":[[5,4,1,"","default_requirements"],[5,3,1,"","run"]],"vmklib.tasks.python.yaml":[[5,2,1,"","Yamllint"],[5,1,1,"","register"]],"vmklib.tasks.python.yaml.Yamllint":[[5,4,1,"","default_requirements"],[5,3,1,"","run"]],"vmklib.tasks.release":[[2,2,1,"","GithubRelease"]],"vmklib.tasks.release.GithubRelease":[[2,3,1,"","create_release"],[2,3,1,"","release"],[2,3,1,"","run"],[2,3,1,"","upload_release_asset"]],"vmklib.tasks.venv":[[2,2,1,"","RequirementsInstaller"],[2,2,1,"","Venv"],[2,1,1,"","register"]],"vmklib.tasks.venv.RequirementsInstaller":[[2,3,1,"","run"]],"vmklib.tasks.venv.Venv":[[2,3,1,"","run"],[2,3,1,"","run_enter"]],"vmklib.util":[[1,1,1,"","to_slug"]]},"objnames":{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},"objtypes":{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},"terms":{"A":[2,3,4,5],"An":1,"By":3,"If":1,"This":[1,3],"_arg":[2,3],"_default":2,"_inbox":[2,3],"_kwarg":[2,3],"_outbox":[2,3],"add":[1,2],"add_app_arg":[0,1],"aggreg":3,"alia":3,"also":2,"analysi":5,"ani":[1,2,3,4,5],"api":2,"app":0,"applic":1,"arg":[0,1,3,4,5],"argument":[1,2,3],"argumentpars":1,"argv":1,"assess":3,"asset":2,"assist":2,"async":[2,3,4,5],"attempt":[2,5],"back":2,"base":[2,3,4,5],"boilerpl":1,"bool":[2,3,4,5],"bootstrap":3,"build":[1,2,3],"build_dir":[1,2],"build_makefil":[0,1],"callabl":[2,3,4,5],"can":1,"candid":3,"check":[2,3,5],"class":[2,3,4,5],"classmethod":2,"clean":[0,1],"code":[2,3],"command":[1,3,4,5],"commandresult":[2,3],"compat":3,"compil":3,"complet":[2,3],"concret":[1,2],"concrete_path":[2,3],"concretebuildermixin":[2,3],"concreteoncemixin":[2,3,5],"configur":[1,2,3],"consid":0,"contain":3,"convert":1,"coroutin":[2,3,4,5],"creat":[2,3,5],"create_releas":[1,2],"curl":[1,2],"curl_head":[2,3],"curlmixin":[2,3],"cwd":[2,4,5],"data":[1,2,3],"datazen":[1,2],"datazentask":[2,5],"default":[1,3],"default_requir":[1,2,5],"develop":0,"dict":[1,2,3,4,5],"directori":[1,2,3,5],"disk":3,"dist":2,"doc":[1,2],"document":5,"either":1,"endpoint":2,"ensur":[2,3],"ensure_api_token":[1,2],"entri":[0,3,5],"environ":[2,5],"environ_fallback":[1,2],"environ_fallback_split":[1,2],"execut":[1,2,3,4,5],"expos":[1,2],"extern":1,"fall":2,"field":3,"file":[2,3],"found":1,"generat":[2,3],"get":[2,3,5],"get_data":[0,1],"github":[0,1],"githubreleas":[1,2],"given":2,"gnu":3,"guess":1,"header":[2,3],"implement":[2,4,5],"import":1,"inbox":[2,3,4,5],"individu":5,"init":[2,5],"initialize_task_manag":[0,1],"instal":[2,5],"int":[1,2,3],"interfac":1,"intern":1,"is_concrete_stal":[2,3],"iter":[1,3],"js":4,"key":2,"keyword":2,"kind":2,"kwarg":[2,3,4,5],"like":3,"line":1,"lint":[1,2],"linter":5,"linter_arg":[2,5],"list":[1,2,5],"load":1,"log":[2,3,4,5],"logger":[2,3,4,5],"main":[0,1,3],"make":3,"makefil":1,"manag":[1,2,4,5],"metadata":1,"method":3,"miscellan":1,"mixin":[1,2],"modifi":3,"modul":0,"name":[1,2,3,4,5],"namedtupl":3,"namespac":1,"need":3,"ninja":[2,3],"node":[1,2],"none":[1,2,3,4,5],"npx":[2,4],"number":3,"onc":3,"onli":3,"option":2,"otherwis":2,"outbox":[2,4,5],"output":[2,3],"owner":2,"packag":0,"parent":1,"parser":1,"path":[1,2,3,4,5],"point":[1,5],"post_data":3,"prefix":1,"program":[1,5],"proj":1,"project":[0,1,2,4,5],"prototyp":2,"provid":1,"pydep":5,"pydepstask":[2,5],"pytest":5,"python":[1,2],"python_entri":[2,5],"python_vers":[2,5],"pythonbuild":[2,5],"pythonlint":[2,5],"pythonpackag":[2,5],"pythontest":[2,5],"regist":[1,2,4,5],"releas":[0,1],"release_id":2,"remov":2,"repo":2,"repo_url":[1,2],"request":1,"requir":2,"requirementsinstal":[1,2],"result":3,"retriev":2,"return":1,"ruff":5,"run":[1,2,3,4,5],"run_ent":[1,2,3],"run_exit":[2,3],"s":[1,2,5],"sa":[1,2],"script":5,"separ":2,"set":[2,5],"singl":5,"slug":1,"sourc":[1,2,3,4,5],"source_arg":[2,5],"specif":1,"sponsor":0,"static":5,"stderr":[2,3],"stdout":[2,3],"str":[1,2,3,4,5],"string":[1,5],"submodul":0,"subpackag":0,"subprocesslogmixin":[2,3,4,5],"substitut":[1,2,3,4,5],"system":[2,3],"t":1,"target":[1,2,3,4,5],"task":[0,1],"task_regist":1,"taskmanag":[1,2,4,5],"temporari":1,"test":[1,2],"text":3,"timer":[2,3,4,5],"to_slug":[0,1],"token":2,"tool":3,"true":3,"tupl":1,"unit":5,"updat":[2,3,5],"update_concret":[2,3],"upload":2,"upload_release_asset":[1,2],"url":2,"use":[1,2,3,5],"user_fil":1,"util":[0,5],"valu":2,"variabl":2,"venv":[0,1,5],"venv_bin":[2,5],"venv_dir":[2,5],"venv_nam":[2,5],"version":[2,5],"virtual":[2,5],"vmklibbas":[1,2,3],"wasn":1,"whitespac":2,"within":5,"work":[2,3,4,5],"write":3,"yaml":[1,2],"yamllint":[2,5]},"titles":["vmklib","vmklib package","vmklib.tasks package","vmklib.tasks.mixins package","vmklib.tasks.node package","vmklib.tasks.python package"],"titleterms":{"app":1,"arg":2,"build":5,"clean":2,"concret":3,"content":[0,1,2,3,4,5],"curl":3,"datazen":5,"doc":5,"entri":1,"github":2,"lint":5,"mixin":3,"modul":[1,2,3,4,5],"node":4,"packag":[1,2,3,4,5],"python":5,"releas":[2,5],"sa":5,"submodul":[1,2,3,5],"subpackag":[1,2],"task":[2,3,4,5],"test":5,"util":1,"venv":2,"vmklib":[0,1,2,3,4,5],"yaml":5}}) | ||
| Search.setIndex({"alltitles":{"Command-line Options":[[0,"command-line-options"]],"Commands":[[0,"commands"],[0,"id2"],[0,"id4"],[0,"id6"],[0,"id8"],[0,"id9"],[0,"id11"]],"Interface Documentation":[[0,null]],"Internal Dependency Graph":[[0,"internal-dependency-graph"]],"Introduction":[[0,"introduction"]],"Module contents":[[1,"module-vmklib"],[2,"module-vmklib.tasks"],[3,"module-vmklib.tasks.mixins"],[4,"module-vmklib.tasks.node"],[5,"module-vmklib.tasks.python"]],"Optional Arguments":[[0,"optional-arguments"],[0,"id1"],[0,"id3"],[0,"id5"],[0,"id7"],[0,"id10"]],"Platform Support":[[0,"platform-support"]],"Python Version Support":[[0,"python-version-support"]],"Submodules":[[1,"submodules"],[2,"submodules"],[3,"submodules"],[5,"submodules"]],"Subpackages":[[1,"subpackages"],[2,"subpackages"]],"Targets":[[0,"targets"]],"datazen":[[0,"datazen"]],"grip":[[0,"grip"]],"pypi":[[0,"pypi"]],"python":[[0,"python"]],"venv":[[0,"venv"]],"vmklib":[[0,"vmklib"]],"vmklib (2.0.12)":[[0,null]],"vmklib package":[[1,null]],"vmklib.app module":[[1,"module-vmklib.app"]],"vmklib.entry module":[[1,"module-vmklib.entry"]],"vmklib.tasks package":[[2,null]],"vmklib.tasks.args module":[[2,"module-vmklib.tasks.args"]],"vmklib.tasks.clean module":[[2,"module-vmklib.tasks.clean"]],"vmklib.tasks.github module":[[2,"module-vmklib.tasks.github"]],"vmklib.tasks.mixins package":[[3,null]],"vmklib.tasks.mixins.concrete module":[[3,"module-vmklib.tasks.mixins.concrete"]],"vmklib.tasks.mixins.curl module":[[3,"module-vmklib.tasks.mixins.curl"]],"vmklib.tasks.node package":[[4,null]],"vmklib.tasks.python package":[[5,null]],"vmklib.tasks.python.build module":[[5,"module-vmklib.tasks.python.build"]],"vmklib.tasks.python.datazen module":[[5,"module-vmklib.tasks.python.datazen"]],"vmklib.tasks.python.docs module":[[5,"module-vmklib.tasks.python.docs"]],"vmklib.tasks.python.lint module":[[5,"module-vmklib.tasks.python.lint"]],"vmklib.tasks.python.package module":[[5,"module-vmklib.tasks.python.package"]],"vmklib.tasks.python.release module":[[5,"module-vmklib.tasks.python.release"]],"vmklib.tasks.python.sa module":[[5,"module-vmklib.tasks.python.sa"]],"vmklib.tasks.python.test module":[[5,"module-vmklib.tasks.python.test"]],"vmklib.tasks.python.yaml module":[[5,"module-vmklib.tasks.python.yaml"]],"vmklib.tasks.release module":[[2,"module-vmklib.tasks.release"]],"vmklib.tasks.venv module":[[2,"module-vmklib.tasks.venv"]],"vmklib.util module":[[1,"module-vmklib.util"]],"yaml":[[0,"yaml"]]},"docnames":["index","vmklib","vmklib.tasks","vmklib.tasks.mixins","vmklib.tasks.node","vmklib.tasks.python"],"envversion":{"sphinx":66,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1},"filenames":["index.rst","vmklib.rst","vmklib.tasks.rst","vmklib.tasks.mixins.rst","vmklib.tasks.node.rst","vmklib.tasks.python.rst"],"indexentries":{"add_app_args() (in module vmklib.app)":[[1,"vmklib.app.add_app_args",false]],"build_dir() (vmklib.tasks.vmklibbase class method)":[[2,"vmklib.tasks.VmklibBase.build_dir",false]],"build_makefile() (in module vmklib.app)":[[1,"vmklib.app.build_makefile",false]],"clean (class in vmklib.tasks.clean)":[[2,"vmklib.tasks.clean.Clean",false]],"code (vmklib.tasks.mixins.commandresult attribute)":[[3,"vmklib.tasks.mixins.CommandResult.code",false]],"code (vmklib.tasks.mixins.curl.commandresult attribute)":[[3,"vmklib.tasks.mixins.curl.CommandResult.code",false]],"commandresult (class in vmklib.tasks.mixins)":[[3,"vmklib.tasks.mixins.CommandResult",false]],"commandresult (class in vmklib.tasks.mixins.curl)":[[3,"vmklib.tasks.mixins.curl.CommandResult",false]],"concrete_path() (vmklib.tasks.mixins.concrete.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin.concrete_path",false]],"concrete_path() (vmklib.tasks.mixins.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.ConcreteBuilderMixin.concrete_path",false]],"concretebuildermixin (class in vmklib.tasks.mixins)":[[3,"vmklib.tasks.mixins.ConcreteBuilderMixin",false]],"concretebuildermixin (class in vmklib.tasks.mixins.concrete)":[[3,"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin",false]],"concreteoncemixin (class in vmklib.tasks.mixins)":[[3,"vmklib.tasks.mixins.ConcreteOnceMixin",false]],"concreteoncemixin (class in vmklib.tasks.mixins.concrete)":[[3,"vmklib.tasks.mixins.concrete.ConcreteOnceMixin",false]],"create_release() (vmklib.tasks.release.githubrelease method)":[[2,"vmklib.tasks.release.GithubRelease.create_release",false]],"curl() (vmklib.tasks.mixins.curl.curlmixin method)":[[3,"vmklib.tasks.mixins.curl.CurlMixin.curl",false]],"curl() (vmklib.tasks.mixins.curlmixin method)":[[3,"vmklib.tasks.mixins.CurlMixin.curl",false]],"curl_headers() (in module vmklib.tasks.mixins)":[[3,"vmklib.tasks.mixins.curl_headers",false]],"curl_headers() (in module vmklib.tasks.mixins.curl)":[[3,"vmklib.tasks.mixins.curl.curl_headers",false]],"curlmixin (class in vmklib.tasks.mixins)":[[3,"vmklib.tasks.mixins.CurlMixin",false]],"curlmixin (class in vmklib.tasks.mixins.curl)":[[3,"vmklib.tasks.mixins.curl.CurlMixin",false]],"datazentask (class in vmklib.tasks.python.datazen)":[[5,"vmklib.tasks.python.datazen.DatazenTask",false]],"default_requirements (vmklib.tasks.python.datazen.datazentask attribute)":[[5,"vmklib.tasks.python.datazen.DatazenTask.default_requirements",false]],"default_requirements (vmklib.tasks.python.docs.pydepstask attribute)":[[5,"vmklib.tasks.python.docs.PydepsTask.default_requirements",false]],"default_requirements (vmklib.tasks.python.lint.pythonlinter attribute)":[[5,"vmklib.tasks.python.lint.PythonLinter.default_requirements",false]],"default_requirements (vmklib.tasks.python.package.pythonpackage attribute)":[[5,"vmklib.tasks.python.package.PythonPackage.default_requirements",false]],"default_requirements (vmklib.tasks.python.test.pythontester attribute)":[[5,"vmklib.tasks.python.test.PythonTester.default_requirements",false]],"default_requirements (vmklib.tasks.python.yaml.yamllint attribute)":[[5,"vmklib.tasks.python.yaml.Yamllint.default_requirements",false]],"default_requirements (vmklib.tasks.vmklibbase attribute)":[[2,"vmklib.tasks.VmklibBase.default_requirements",false]],"ensure_api_token() (in module vmklib.tasks.github)":[[2,"vmklib.tasks.github.ensure_api_token",false]],"entry() (in module vmklib.app)":[[1,"vmklib.app.entry",false]],"environ_fallback() (in module vmklib.tasks.args)":[[2,"vmklib.tasks.args.environ_fallback",false]],"environ_fallback_split() (in module vmklib.tasks.args)":[[2,"vmklib.tasks.args.environ_fallback_split",false]],"get_data() (in module vmklib.app)":[[1,"vmklib.app.get_data",false]],"githubrelease (class in vmklib.tasks.release)":[[2,"vmklib.tasks.release.GithubRelease",false]],"initialize_task_manager() (in module vmklib.app)":[[1,"vmklib.app.initialize_task_manager",false]],"is_concrete_stale() (vmklib.tasks.mixins.concrete.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin.is_concrete_stale",false]],"is_concrete_stale() (vmklib.tasks.mixins.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.ConcreteBuilderMixin.is_concrete_stale",false]],"linter_args (vmklib.tasks.python.lint.pythonlinter attribute)":[[5,"vmklib.tasks.python.lint.PythonLinter.linter_args",false]],"main() (in module vmklib.entry)":[[1,"vmklib.entry.main",false]],"module":[[1,"module-vmklib",false],[1,"module-vmklib.app",false],[1,"module-vmklib.entry",false],[1,"module-vmklib.util",false],[2,"module-vmklib.tasks",false],[2,"module-vmklib.tasks.args",false],[2,"module-vmklib.tasks.clean",false],[2,"module-vmklib.tasks.github",false],[2,"module-vmklib.tasks.release",false],[2,"module-vmklib.tasks.venv",false],[3,"module-vmklib.tasks.mixins",false],[3,"module-vmklib.tasks.mixins.concrete",false],[3,"module-vmklib.tasks.mixins.curl",false],[4,"module-vmklib.tasks.node",false],[5,"module-vmklib.tasks.python",false],[5,"module-vmklib.tasks.python.build",false],[5,"module-vmklib.tasks.python.datazen",false],[5,"module-vmklib.tasks.python.docs",false],[5,"module-vmklib.tasks.python.lint",false],[5,"module-vmklib.tasks.python.package",false],[5,"module-vmklib.tasks.python.release",false],[5,"module-vmklib.tasks.python.sa",false],[5,"module-vmklib.tasks.python.test",false],[5,"module-vmklib.tasks.python.yaml",false]],"npx (class in vmklib.tasks.node)":[[4,"vmklib.tasks.node.Npx",false]],"project() (in module vmklib.app)":[[1,"vmklib.app.project",false]],"pydepstask (class in vmklib.tasks.python.docs)":[[5,"vmklib.tasks.python.docs.PydepsTask",false]],"python_entry() (in module vmklib.tasks.python)":[[5,"vmklib.tasks.python.python_entry",false]],"python_version() (in module vmklib.tasks.python)":[[5,"vmklib.tasks.python.python_version",false]],"pythonbuild (class in vmklib.tasks.python.build)":[[5,"vmklib.tasks.python.build.PythonBuild",false]],"pythonlinter (class in vmklib.tasks.python.lint)":[[5,"vmklib.tasks.python.lint.PythonLinter",false]],"pythonpackage (class in vmklib.tasks.python.package)":[[5,"vmklib.tasks.python.package.PythonPackage",false]],"pythontester (class in vmklib.tasks.python.test)":[[5,"vmklib.tasks.python.test.PythonTester",false]],"register() (in module vmklib.tasks.node)":[[4,"vmklib.tasks.node.register",false]],"register() (in module vmklib.tasks.python.build)":[[5,"vmklib.tasks.python.build.register",false]],"register() (in module vmklib.tasks.python.datazen)":[[5,"vmklib.tasks.python.datazen.register",false]],"register() (in module vmklib.tasks.python.docs)":[[5,"vmklib.tasks.python.docs.register",false]],"register() (in module vmklib.tasks.python.lint)":[[5,"vmklib.tasks.python.lint.register",false]],"register() (in module vmklib.tasks.python.package)":[[5,"vmklib.tasks.python.package.register",false]],"register() (in module vmklib.tasks.python.release)":[[5,"vmklib.tasks.python.release.register",false]],"register() (in module vmklib.tasks.python.sa)":[[5,"vmklib.tasks.python.sa.register",false]],"register() (in module vmklib.tasks.python.test)":[[5,"vmklib.tasks.python.test.register",false]],"register() (in module vmklib.tasks.python.yaml)":[[5,"vmklib.tasks.python.yaml.register",false]],"register() (in module vmklib.tasks.venv)":[[2,"vmklib.tasks.venv.register",false]],"release() (vmklib.tasks.release.githubrelease method)":[[2,"vmklib.tasks.release.GithubRelease.release",false]],"repo_url() (in module vmklib.tasks.github)":[[2,"vmklib.tasks.github.repo_url",false]],"requirementsinstaller (class in vmklib.tasks.venv)":[[2,"vmklib.tasks.venv.RequirementsInstaller",false]],"run() (vmklib.tasks.clean.clean method)":[[2,"vmklib.tasks.clean.Clean.run",false]],"run() (vmklib.tasks.node.npx method)":[[4,"vmklib.tasks.node.Npx.run",false]],"run() (vmklib.tasks.python.build.pythonbuild method)":[[5,"vmklib.tasks.python.build.PythonBuild.run",false]],"run() (vmklib.tasks.python.datazen.datazentask method)":[[5,"vmklib.tasks.python.datazen.DatazenTask.run",false]],"run() (vmklib.tasks.python.docs.pydepstask method)":[[5,"vmklib.tasks.python.docs.PydepsTask.run",false]],"run() (vmklib.tasks.python.lint.pythonlinter method)":[[5,"vmklib.tasks.python.lint.PythonLinter.run",false]],"run() (vmklib.tasks.python.package.pythonpackage method)":[[5,"vmklib.tasks.python.package.PythonPackage.run",false]],"run() (vmklib.tasks.python.test.pythontester method)":[[5,"vmklib.tasks.python.test.PythonTester.run",false]],"run() (vmklib.tasks.python.yaml.yamllint method)":[[5,"vmklib.tasks.python.yaml.Yamllint.run",false]],"run() (vmklib.tasks.release.githubrelease method)":[[2,"vmklib.tasks.release.GithubRelease.run",false]],"run() (vmklib.tasks.venv.requirementsinstaller method)":[[2,"vmklib.tasks.venv.RequirementsInstaller.run",false]],"run() (vmklib.tasks.venv.venv method)":[[2,"vmklib.tasks.venv.Venv.run",false]],"run_enter() (vmklib.tasks.mixins.concrete.concreteoncemixin method)":[[3,"vmklib.tasks.mixins.concrete.ConcreteOnceMixin.run_enter",false]],"run_enter() (vmklib.tasks.mixins.concreteoncemixin method)":[[3,"vmklib.tasks.mixins.ConcreteOnceMixin.run_enter",false]],"run_enter() (vmklib.tasks.venv.venv method)":[[2,"vmklib.tasks.venv.Venv.run_enter",false]],"run_exit() (vmklib.tasks.mixins.concrete.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin.run_exit",false]],"run_exit() (vmklib.tasks.mixins.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.ConcreteBuilderMixin.run_exit",false]],"source_args() (vmklib.tasks.python.lint.pythonlinter static method)":[[5,"vmklib.tasks.python.lint.PythonLinter.source_args",false]],"stderr (vmklib.tasks.mixins.commandresult attribute)":[[3,"vmklib.tasks.mixins.CommandResult.stderr",false]],"stderr (vmklib.tasks.mixins.curl.commandresult attribute)":[[3,"vmklib.tasks.mixins.curl.CommandResult.stderr",false]],"stdout (vmklib.tasks.mixins.commandresult attribute)":[[3,"vmklib.tasks.mixins.CommandResult.stdout",false]],"stdout (vmklib.tasks.mixins.curl.commandresult attribute)":[[3,"vmklib.tasks.mixins.curl.CommandResult.stdout",false]],"to_slug() (in module vmklib.util)":[[1,"vmklib.util.to_slug",false]],"update_concrete() (vmklib.tasks.mixins.concrete.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin.update_concrete",false]],"update_concrete() (vmklib.tasks.mixins.concretebuildermixin method)":[[3,"vmklib.tasks.mixins.ConcreteBuilderMixin.update_concrete",false]],"upload_release_asset() (vmklib.tasks.release.githubrelease method)":[[2,"vmklib.tasks.release.GithubRelease.upload_release_asset",false]],"venv (class in vmklib.tasks.venv)":[[2,"vmklib.tasks.venv.Venv",false]],"venv_bin() (in module vmklib.tasks.python)":[[5,"vmklib.tasks.python.venv_bin",false]],"venv_dir() (in module vmklib.tasks.python)":[[5,"vmklib.tasks.python.venv_dir",false]],"venv_name() (in module vmklib.tasks.python)":[[5,"vmklib.tasks.python.venv_name",false]],"vmklib":[[1,"module-vmklib",false]],"vmklib.app":[[1,"module-vmklib.app",false]],"vmklib.entry":[[1,"module-vmklib.entry",false]],"vmklib.tasks":[[2,"module-vmklib.tasks",false]],"vmklib.tasks.args":[[2,"module-vmklib.tasks.args",false]],"vmklib.tasks.clean":[[2,"module-vmklib.tasks.clean",false]],"vmklib.tasks.github":[[2,"module-vmklib.tasks.github",false]],"vmklib.tasks.mixins":[[3,"module-vmklib.tasks.mixins",false]],"vmklib.tasks.mixins.concrete":[[3,"module-vmklib.tasks.mixins.concrete",false]],"vmklib.tasks.mixins.curl":[[3,"module-vmklib.tasks.mixins.curl",false]],"vmklib.tasks.node":[[4,"module-vmklib.tasks.node",false]],"vmklib.tasks.python":[[5,"module-vmklib.tasks.python",false]],"vmklib.tasks.python.build":[[5,"module-vmklib.tasks.python.build",false]],"vmklib.tasks.python.datazen":[[5,"module-vmklib.tasks.python.datazen",false]],"vmklib.tasks.python.docs":[[5,"module-vmklib.tasks.python.docs",false]],"vmklib.tasks.python.lint":[[5,"module-vmklib.tasks.python.lint",false]],"vmklib.tasks.python.package":[[5,"module-vmklib.tasks.python.package",false]],"vmklib.tasks.python.release":[[5,"module-vmklib.tasks.python.release",false]],"vmklib.tasks.python.sa":[[5,"module-vmklib.tasks.python.sa",false]],"vmklib.tasks.python.test":[[5,"module-vmklib.tasks.python.test",false]],"vmklib.tasks.python.yaml":[[5,"module-vmklib.tasks.python.yaml",false]],"vmklib.tasks.release":[[2,"module-vmklib.tasks.release",false]],"vmklib.tasks.venv":[[2,"module-vmklib.tasks.venv",false]],"vmklib.util":[[1,"module-vmklib.util",false]],"vmklibbase (class in vmklib.tasks)":[[2,"vmklib.tasks.VmklibBase",false]],"yamllint (class in vmklib.tasks.python.yaml)":[[5,"vmklib.tasks.python.yaml.Yamllint",false]]},"objects":{"":[[1,0,0,"-","vmklib"]],"vmklib":[[1,0,0,"-","app"],[1,0,0,"-","entry"],[2,0,0,"-","tasks"],[1,0,0,"-","util"]],"vmklib.app":[[1,1,1,"","add_app_args"],[1,1,1,"","build_makefile"],[1,1,1,"","entry"],[1,1,1,"","get_data"],[1,1,1,"","initialize_task_manager"],[1,1,1,"","project"]],"vmklib.entry":[[1,1,1,"","main"]],"vmklib.tasks":[[2,2,1,"","VmklibBase"],[2,0,0,"-","args"],[2,0,0,"-","clean"],[2,0,0,"-","github"],[3,0,0,"-","mixins"],[4,0,0,"-","node"],[5,0,0,"-","python"],[2,0,0,"-","release"],[2,0,0,"-","venv"]],"vmklib.tasks.VmklibBase":[[2,3,1,"","build_dir"],[2,4,1,"","default_requirements"]],"vmklib.tasks.args":[[2,1,1,"","environ_fallback"],[2,1,1,"","environ_fallback_split"]],"vmklib.tasks.clean":[[2,2,1,"","Clean"]],"vmklib.tasks.clean.Clean":[[2,3,1,"","run"]],"vmklib.tasks.github":[[2,1,1,"","ensure_api_token"],[2,1,1,"","repo_url"]],"vmklib.tasks.mixins":[[3,2,1,"","CommandResult"],[3,2,1,"","ConcreteBuilderMixin"],[3,2,1,"","ConcreteOnceMixin"],[3,2,1,"","CurlMixin"],[3,0,0,"-","concrete"],[3,0,0,"-","curl"],[3,1,1,"","curl_headers"]],"vmklib.tasks.mixins.CommandResult":[[3,4,1,"","code"],[3,4,1,"","stderr"],[3,4,1,"","stdout"]],"vmklib.tasks.mixins.ConcreteBuilderMixin":[[3,3,1,"","concrete_path"],[3,3,1,"","is_concrete_stale"],[3,3,1,"","run_exit"],[3,3,1,"","update_concrete"]],"vmklib.tasks.mixins.ConcreteOnceMixin":[[3,3,1,"","run_enter"]],"vmklib.tasks.mixins.CurlMixin":[[3,3,1,"","curl"]],"vmklib.tasks.mixins.concrete":[[3,2,1,"","ConcreteBuilderMixin"],[3,2,1,"","ConcreteOnceMixin"]],"vmklib.tasks.mixins.concrete.ConcreteBuilderMixin":[[3,3,1,"","concrete_path"],[3,3,1,"","is_concrete_stale"],[3,3,1,"","run_exit"],[3,3,1,"","update_concrete"]],"vmklib.tasks.mixins.concrete.ConcreteOnceMixin":[[3,3,1,"","run_enter"]],"vmklib.tasks.mixins.curl":[[3,2,1,"","CommandResult"],[3,2,1,"","CurlMixin"],[3,1,1,"","curl_headers"]],"vmklib.tasks.mixins.curl.CommandResult":[[3,4,1,"","code"],[3,4,1,"","stderr"],[3,4,1,"","stdout"]],"vmklib.tasks.mixins.curl.CurlMixin":[[3,3,1,"","curl"]],"vmklib.tasks.node":[[4,2,1,"","Npx"],[4,1,1,"","register"]],"vmklib.tasks.node.Npx":[[4,3,1,"","run"]],"vmklib.tasks.python":[[5,0,0,"-","build"],[5,0,0,"-","datazen"],[5,0,0,"-","docs"],[5,0,0,"-","lint"],[5,0,0,"-","package"],[5,1,1,"","python_entry"],[5,1,1,"","python_version"],[5,0,0,"-","release"],[5,0,0,"-","sa"],[5,0,0,"-","test"],[5,1,1,"","venv_bin"],[5,1,1,"","venv_dir"],[5,1,1,"","venv_name"],[5,0,0,"-","yaml"]],"vmklib.tasks.python.build":[[5,2,1,"","PythonBuild"],[5,1,1,"","register"]],"vmklib.tasks.python.build.PythonBuild":[[5,3,1,"","run"]],"vmklib.tasks.python.datazen":[[5,2,1,"","DatazenTask"],[5,1,1,"","register"]],"vmklib.tasks.python.datazen.DatazenTask":[[5,4,1,"","default_requirements"],[5,3,1,"","run"]],"vmklib.tasks.python.docs":[[5,2,1,"","PydepsTask"],[5,1,1,"","register"]],"vmklib.tasks.python.docs.PydepsTask":[[5,4,1,"","default_requirements"],[5,3,1,"","run"]],"vmklib.tasks.python.lint":[[5,2,1,"","PythonLinter"],[5,1,1,"","register"]],"vmklib.tasks.python.lint.PythonLinter":[[5,4,1,"","default_requirements"],[5,4,1,"","linter_args"],[5,3,1,"","run"],[5,3,1,"","source_args"]],"vmklib.tasks.python.package":[[5,2,1,"","PythonPackage"],[5,1,1,"","register"]],"vmklib.tasks.python.package.PythonPackage":[[5,4,1,"","default_requirements"],[5,3,1,"","run"]],"vmklib.tasks.python.release":[[5,1,1,"","register"]],"vmklib.tasks.python.sa":[[5,1,1,"","register"]],"vmklib.tasks.python.test":[[5,2,1,"","PythonTester"],[5,1,1,"","register"]],"vmklib.tasks.python.test.PythonTester":[[5,4,1,"","default_requirements"],[5,3,1,"","run"]],"vmklib.tasks.python.yaml":[[5,2,1,"","Yamllint"],[5,1,1,"","register"]],"vmklib.tasks.python.yaml.Yamllint":[[5,4,1,"","default_requirements"],[5,3,1,"","run"]],"vmklib.tasks.release":[[2,2,1,"","GithubRelease"]],"vmklib.tasks.release.GithubRelease":[[2,3,1,"","create_release"],[2,3,1,"","release"],[2,3,1,"","run"],[2,3,1,"","upload_release_asset"]],"vmklib.tasks.venv":[[2,2,1,"","RequirementsInstaller"],[2,2,1,"","Venv"],[2,1,1,"","register"]],"vmklib.tasks.venv.RequirementsInstaller":[[2,3,1,"","run"]],"vmklib.tasks.venv.Venv":[[2,3,1,"","run"],[2,3,1,"","run_enter"]],"vmklib.util":[[1,1,1,"","to_slug"]]},"objnames":{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},"objtypes":{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},"terms":{"A":[0,2,3,4,5],"An":1,"By":3,"If":1,"The":0,"There":0,"These":0,"This":[0,1,3],"_arg":[2,3],"_default":2,"_inbox":[2,3],"_kwarg":[2,3],"_outbox":[2,3],"access":0,"add":[0,1,2],"add_app_arg":[0,1],"addit":0,"aggreg":[0,3],"ahead":0,"alia":3,"allow":0,"also":[0,2],"analysi":[0,5],"ani":[0,1,2,3,4,5],"api":[0,2],"app":0,"appli":0,"applic":1,"arbitrari":0,"arg":[0,1,3,4,5],"arg1":0,"arg2":0,"argument":[1,2,3],"argumentpars":1,"argv":1,"artifact":0,"assess":3,"asset":2,"assist":2,"async":[2,3,4,5],"attempt":[0,2,5],"back":[0,2],"base":[0,2,3,4,5],"bdist_wheel":0,"bin":0,"black":0,"boilerpl":1,"bool":[2,3,4,5],"bootstrap":[0,3],"browser":0,"build":[0,1,2,3],"build_dir":[1,2],"build_makefil":[0,1],"built":0,"c":0,"cach":0,"callabl":[2,3,4,5],"can":[0,1],"candid":3,"case":0,"check":[0,2,3,5],"checker":0,"choic":0,"class":[2,3,4,5],"classmethod":2,"clean":[0,1],"coars":0,"code":[0,2,3],"command":[1,3,4,5],"commandresult":[2,3],"common":0,"compat":3,"compil":[0,3],"complet":[2,3],"concret":[0,1,2],"concrete_path":[2,3],"concretebuildermixin":[2,3],"concreteoncemixin":[2,3,5],"config":0,"configur":[1,2,3],"consid":0,"contain":[0,3],"content":0,"convert":1,"coroutin":[2,3,4,5],"coverag":0,"creat":[0,2,3,5],"create_releas":[1,2],"credenti":0,"ctag":0,"curl":[1,2],"curl_head":[2,3],"curlmixin":[2,3],"curs":0,"cwd":[2,4,5],"d":0,"data":[0,1,2,3],"datazen":[1,2],"datazentask":[2,5],"default":[0,1,3],"default_requir":[1,2,5],"definit":0,"dep":0,"describ":0,"dev_requir":0,"develop":0,"dict":[1,2,3,4,5],"dir":0,"directori":[0,1,2,3,5],"disabl":0,"disk":3,"dist":[0,2],"distribut":0,"doc":[0,1,2],"document":5,"driver":0,"dz":0,"dz_dir":0,"dz_manifest":0,"dz_verbos":0,"e":0,"edit":0,"editor":0,"either":1,"els":0,"endpoint":2,"enforc":0,"ensur":[2,3],"ensure_api_token":[1,2],"entri":[0,3,5],"env":0,"environ":[0,2,5],"environ_fallback":[1,2],"environ_fallback_split":[1,2],"error":0,"event":0,"everyth":0,"everywher":0,"execut":[0,1,2,3,4,5],"exist":0,"exit":0,"expos":[1,2],"extern":1,"extra":0,"f":0,"fall":2,"fals":0,"field":3,"file":[0,2,3],"flake8":0,"follow":0,"format":0,"formatt":0,"found":1,"full":0,"g":0,"generat":[0,2,3],"get":[2,3,5],"get_data":[0,1],"github":[0,1],"githubreleas":[1,2],"given":2,"gnu":[0,3],"grip_env":0,"grip_fil":0,"grip_port":0,"grip_token":0,"guess":1,"h":0,"header":[0,2,3],"help":0,"host":0,"html":0,"http":0,"implement":[2,4,5],"import":1,"improv":0,"inbox":[2,3,4,5],"includ":0,"increas":0,"individu":5,"infrastructur":0,"init":[2,5],"initialize_task_manag":[0,1],"insensit":0,"instal":[0,2,5],"int":[1,2,3],"integr":0,"intend":0,"interact":0,"interfac":1,"intern":1,"invoc":0,"is_concrete_stal":[2,3],"isort":0,"iter":[1,3],"js":4,"json":0,"k":0,"key":2,"keyword":2,"kind":2,"kwarg":[2,3,4,5],"latest":0,"learn":0,"length":0,"lesson":0,"like":3,"line":1,"lint":[0,1,2],"linter":5,"linter_arg":[2,5],"list":[1,2,5],"load":[0,1],"local":0,"locat":0,"log":[0,2,3,4,5],"logger":[2,3,4,5],"loop":0,"m":0,"maco":0,"main":[0,1,3],"make":[0,3],"makefil":[0,1],"manag":[0,1,2,4,5],"mani":0,"manifest":0,"markdown":0,"md":0,"messag":0,"metadata":1,"method":3,"minor":0,"miscellan":1,"miss":0,"mixin":[1,2],"mk":0,"mode":0,"modifi":3,"modul":0,"must":0,"mypi":0,"n":0,"name":[0,1,2,3,4,5],"namedtupl":3,"namespac":1,"necessari":0,"need":3,"ninja":[2,3],"node":[1,2],"non":0,"none":[0,1,2,3,4,5],"note":0,"npx":[2,4],"number":[0,3],"onc":[0,3],"onli":[0,3],"open":0,"option":2,"otherwis":2,"outbox":[2,4,5],"output":[0,2,3],"overrid":0,"owner":2,"p":0,"packag":0,"parent":1,"parser":1,"pass":0,"path":[0,1,2,3,4,5],"pattern":0,"perform":0,"person":0,"pip":0,"point":[1,5],"port":0,"posit":0,"post_data":3,"prefix":[0,1],"print":0,"produc":0,"product":0,"program":[0,1,5],"proj":[0,1],"project":[0,1,2,4,5],"propag":0,"prototyp":2,"provid":[0,1],"py":0,"py_build":0,"py_docs_extra_arg":0,"py_docs_host":0,"py_docs_port":0,"py_lint_arg":0,"py_lint_extra_arg":0,"py_width":0,"pydep":[0,5],"pydepstask":[2,5],"pydoc":0,"pylint":0,"pytest":[0,5],"pytest_arg":0,"pytest_extra_arg":0,"python":[1,2],"python3":0,"python_cov_port":0,"python_entri":[2,5],"python_vers":[0,2,5],"pythonbuild":[2,5],"pythonlint":[2,5],"pythonpackag":[2,5],"pythontest":[2,5],"q":0,"quiet":0,"r":0,"re":0,"read":0,"readm":0,"recip":0,"reduc":0,"regist":[1,2,4,5],"relat":0,"relationship":0,"releas":[0,1],"release_id":2,"remov":[0,2],"render":0,"repo":2,"repo_url":[1,2],"req_fil":0,"request":1,"requir":[0,2],"requirements_dir":0,"requirementsinstal":[1,2],"resolut":0,"resolv":0,"result":[0,3],"retriev":2,"return":1,"root":0,"ruff":5,"run":[0,1,2,3,4,5],"run_ent":[1,2,3],"run_exit":[2,3],"s":[0,1,2,5],"sa":[0,1,2],"scale":0,"script":5,"sdist":0,"search":0,"secrethub":0,"secrethub_grip_path":0,"secrethub_pypi_path":0,"separ":2,"sequenc":0,"serv":0,"server":0,"set":[0,2,5],"setup":0,"show":0,"simpl":0,"simplifi":0,"singl":5,"slug":1,"small":0,"softwar":0,"sourc":[0,1,2,3,4,5],"source_arg":[2,5],"specif":[0,1],"specifi":0,"sponsor":0,"standard":0,"start":0,"static":[0,5],"stderr":[2,3],"stdout":[2,3],"stem":0,"str":[1,2,3,4,5],"string":[0,1,5],"structur":0,"stub":0,"stubgen":0,"sub":0,"submodul":0,"subpackag":0,"subprocesslogmixin":[2,3,4,5],"subset":0,"substitut":[1,2,3,4,5],"svg":0,"sync":0,"sys":0,"system":[0,2,3],"t":1,"tag":0,"target":[1,2,3,4,5],"task":[0,1],"task_regist":1,"taskmanag":[1,2,4,5],"technolog":0,"temporari":1,"test":[0,1,2],"text":[0,3],"timer":[2,3,4,5],"to_slug":[0,1],"todo":0,"token":[0,2],"tool":[0,3],"true":3,"tupl":1,"twine":0,"twine_password":0,"twine_usernam":0,"txt":0,"type":0,"ubuntu":0,"underlying":0,"unit":5,"updat":[0,2,3,5],"update_concret":[2,3],"upgrad":0,"upload":[0,2],"upload_env":0,"upload_release_asset":[1,2],"url":2,"usag":0,"use":[0,1,2,3,5],"user":0,"user_fil":1,"util":[0,5],"uvloop":0,"v":0,"val1":0,"val2":0,"valu":2,"variabl":[0,2],"venv":[1,5],"venv3":0,"venv_bin":[2,5],"venv_dir":[2,5],"venv_nam":[2,5],"verbos":0,"version":[2,5],"versus":0,"via":0,"view":0,"virtual":[0,2,5],"vmklibbas":[1,2,3],"wasn":1,"wheel":0,"whether":0,"whitespac":2,"window":0,"within":5,"without":0,"work":[2,3,4,5],"workflow":0,"wrapper":0,"write":[0,3],"yaml":[1,2],"yamllint":[0,2,5],"yamllint_arg":0,"zero":0},"titles":["vmklib (2.0.12)","vmklib package","vmklib.tasks package","vmklib.tasks.mixins package","vmklib.tasks.node package","vmklib.tasks.python package"],"titleterms":{"app":1,"arg":2,"argument":0,"build":5,"clean":2,"command":0,"concret":3,"content":[1,2,3,4,5],"curl":3,"datazen":[0,5],"depend":0,"doc":5,"document":0,"entri":1,"github":2,"graph":0,"grip":0,"interfac":0,"intern":0,"introduct":0,"line":0,"lint":5,"mixin":3,"modul":[1,2,3,4,5],"node":4,"option":0,"packag":[1,2,3,4,5],"platform":0,"pypi":0,"python":[0,5],"releas":[2,5],"sa":5,"submodul":[1,2,3,5],"subpackag":[1,2],"support":0,"target":0,"task":[2,3,4,5],"test":5,"util":1,"venv":[0,2],"version":0,"vmklib":[0,1,2,3,4,5],"yaml":[0,5]}}) |
@@ -39,3 +39,3 @@ | ||
| <script src="_static/documentation_options.js?v=55d7fe76"></script> | ||
| <script src="_static/documentation_options.js?v=96e9dbe8"></script> | ||
| <script src="_static/doctools.js?v=fd6eb6e6"></script> | ||
@@ -49,3 +49,3 @@ <script src="_static/sphinx_highlight.js?v=6ffebe34"></script> | ||
| <link rel="next" title="vmklib.tasks package" href="vmklib.tasks.html" /> | ||
| <link rel="prev" title="vmklib" href="index.html" /> | ||
| <link rel="prev" title="vmklib (2.0.12)" href="index.html" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
@@ -160,3 +160,3 @@ <meta name="docsearch:language" content="en"/> | ||
| <div class="bd-toc-item navbar-nav active"> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Interface Documentation</span></p> | ||
| <ul class="current nav bd-sidenav"> | ||
@@ -527,3 +527,3 @@ <li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">vmklib package</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> | ||
| <p class="prev-next-subtitle">previous</p> | ||
| <p class="prev-next-title">vmklib</p> | ||
| <p class="prev-next-title">vmklib (2.0.12)</p> | ||
| </div> | ||
@@ -530,0 +530,0 @@ </a> |
@@ -39,3 +39,3 @@ | ||
| <script src="_static/documentation_options.js?v=55d7fe76"></script> | ||
| <script src="_static/documentation_options.js?v=96e9dbe8"></script> | ||
| <script src="_static/doctools.js?v=fd6eb6e6"></script> | ||
@@ -159,3 +159,3 @@ <script src="_static/sphinx_highlight.js?v=6ffebe34"></script> | ||
| <div class="bd-toc-item navbar-nav active"> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p> | ||
| <p aria-level="2" class="caption" role="heading"><span class="caption-text">Interface Documentation</span></p> | ||
| <ul class="current nav bd-sidenav"> | ||
@@ -162,0 +162,0 @@ <li class="toctree-l1 current active has-children"><a class="reference internal" href="vmklib.html">vmklib package</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current"> |
| vcorelib>=3.6.7 | ||
| experimental-lowqa>=0.1.12 | ||
| experimental-lowqa>=0.2.1 |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Alert delta unavailable
Currently unable to show alert delta for PyPI packages.
5339004
2.3%207
0.49%