lorax/rhel8-branch/pylorax.api.html



<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>pylorax.api package &mdash; Lorax 28.14.58 documentation</title>
  

  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="prev" title="pylorax package" href="pylorax.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

            <a href="index.html" class="icon icon-home"> Lorax
          

          </a>

          
              <div class="version">
                28.14.58
              </div>
            
          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction to Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="product-images.html">Product and Updates Images</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">pylorax</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="pylorax.html">pylorax package</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="pylorax.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4 current"><a class="current reference internal" href="#">pylorax.api package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.base">pylorax.base module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.buildstamp">pylorax.buildstamp module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.cmdline">pylorax.cmdline module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.creator">pylorax.creator module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.decorators">pylorax.decorators module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.discinfo">pylorax.discinfo module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.dnfbase">pylorax.dnfbase module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.dnfhelper">pylorax.dnfhelper module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.executils">pylorax.executils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.imgutils">pylorax.imgutils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.installer">pylorax.installer module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.ltmpl">pylorax.ltmpl module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.monitor">pylorax.monitor module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.mount">pylorax.mount module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.output">pylorax.output module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.sysutils">pylorax.sysutils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.treebuilder">pylorax.treebuilder module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.treeinfo">pylorax.treeinfo module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax">Module contents</a></li>
</ul>
</li>
</ul>
</li>
</ul>

            
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Lorax</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          
<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
        
          <li><a href="modules.html">pylorax</a> &raquo;</li>
        
          <li><a href="pylorax.html">pylorax package</a> &raquo;</li>
        
      <li>pylorax.api package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/pylorax.api.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="pylorax-api-package">
<h1>pylorax.api package<a class="headerlink" href="#pylorax-api-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-pylorax.api.cmdline">
<span id="pylorax-api-cmdline-module"></span><h2>pylorax.api.cmdline module<a class="headerlink" href="#module-pylorax.api.cmdline" title="Permalink to this headline">¶</a></h2>
<dl class="py function">
<dt id="pylorax.api.cmdline.lorax_composer_parser">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.cmdline.</span></code><code class="sig-name descname"><span class="pre">lorax_composer_parser</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/cmdline.html#lorax_composer_parser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.cmdline.lorax_composer_parser" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the ArgumentParser for lorax-composer</p>
</dd></dl>

</div>
<div class="section" id="module-pylorax.api.compose">
<span id="pylorax-api-compose-module"></span><h2>pylorax.api.compose module<a class="headerlink" href="#module-pylorax.api.compose" title="Permalink to this headline">¶</a></h2>
<p>Setup for composing an image</p>
<div class="section" id="adding-new-output-types">
<h3>Adding New Output Types<a class="headerlink" href="#adding-new-output-types" title="Permalink to this headline">¶</a></h3>
<p>The new output type must add a kickstart template to ./share/composer/ where the
name of the kickstart (without the trailing .ks) matches the entry in compose_args.</p>
<p>The kickstart should not have any url or repo entries, these will be added at build
time. The %packages section should be the last thing, and while it can contain mandatory
packages required by the output type, it should not have the trailing %end because the
package NEVRAs will be appended to it at build time.</p>
<p>compose_args should have a name matching the kickstart, and it should set the novirt_install
parameters needed to generate the desired output. Other types should be set to False.</p>
<dl class="py function">
<dt id="pylorax.api.compose.add_customizations">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">add_customizations</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#add_customizations"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.add_customizations" title="Permalink to this definition">¶</a></dt>
<dd><p>Add customizations to the kickstart file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>f</strong> (<em>open file object</em>) – kickstart file object</p></li>
<li><p><strong>recipe</strong> (<em>Recipe object</em>) – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>None</p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p>RuntimeError if there was a problem writing to the kickstart</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.bootloader_append">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">bootloader_append</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kernel_append</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#bootloader_append"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.bootloader_append" title="Permalink to this definition">¶</a></dt>
<dd><p>Insert the kernel_append string into the –append argument</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The bootloader … line</p></li>
<li><p><strong>kernel_append</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The arguments to append to the –append section</p></li>
</ul>
</dd>
</dl>
<p>Using pykickstart to process the line is the best way to make sure it
is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.compose_args">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">compose_args</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compose_type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#compose_args"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.compose_args" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the settings to pass to novirt_install for the compose type</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>compose_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The type of compose to create, from <cite>compose_types()</cite></p>
</dd>
</dl>
<p>This will return a dict of options that match the ArgumentParser options for livemedia-creator.
These are the ones the define the type of output, it’s filename, etc.
Other options will be filled in by <cite>make_compose()</cite></p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.compose_types">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">compose_types</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">share_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#compose_types"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.compose_types" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of tuples of the supported output types, and their state</p>
<p>The output types come from the kickstart names in /usr/share/lorax/composer/*ks</p>
<p>If they are disabled on the current arch their state is False. If enabled, it is True.
eg. [(“alibaba”, False), (“ext4-filesystem”, True), …]</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.customize_ks_template">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">customize_ks_template</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ks_template</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#customize_ks_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.customize_ks_template" title="Permalink to this definition">¶</a></dt>
<dd><p>Customize the kickstart template and return it</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ks_template</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The kickstart template</p></li>
<li><p><strong>recipe</strong> (<em>Recipe object</em>) – </p></li>
</ul>
</dd>
</dl>
<p>Apply customizations to existing template commands, or add defaults for ones that are
missing and required.</p>
<p>Apply customizations.kernel.append to the bootloader argument in the template.
Add bootloader line if it is missing.</p>
<p>Add default timezone if needed. It does NOT replace an existing timezone entry</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.firewall_cmd">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">firewall_cmd</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#firewall_cmd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.firewall_cmd" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the firewall line with the new ports and services</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The firewall … line</p></li>
<li><p><strong>settings</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A dict with the list of services and ports to enable and disable</p></li>
</ul>
</dd>
</dl>
<p>Using pykickstart to process the line is the best way to make sure it
is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.get_default_services">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_default_services</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_default_services"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_default_services" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the default string for services, based on recipe
:param recipe: The recipe</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>string with “services” or “”</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
</dl>
<p>When no services have been selected we don’t need to add anything to the kickstart
so return an empty string. Otherwise return “services” which will be updated with
the settings.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.get_extra_pkgs">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_extra_pkgs</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">share_dir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compose_type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_extra_pkgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_extra_pkgs" title="Permalink to this definition">¶</a></dt>
<dd><p>Return extra packages needed for the output type</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
<li><p><strong>share_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Path to the top level share directory</p></li>
<li><p><strong>compose_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The type of output to create from the recipe</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of package names (name only, not NEVRA)</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a></p>
</dd>
</dl>
<p>Currently this is only needed by live-iso, it reads ./live/live-install.tmpl and
processes only the installpkg lines. It lists the packages needed to complete creation of the
iso using the templates such as x86.tmpl</p>
<p>Keep in mind that the live-install.tmpl is shared between livemedia-creator and lorax-composer,
even though the results are applied differently.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.get_firewall_settings">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_firewall_settings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_firewall_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_firewall_settings" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.firewall settings</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – The recipe</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dict of settings</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.get_kernel_append">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_kernel_append</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_kernel_append"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_kernel_append" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.kernel append value</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>append value or empty string</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.get_keyboard_layout">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_keyboard_layout</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_keyboard_layout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_keyboard_layout" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.locale.keyboard list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – The recipe</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The keyboard layout string</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.get_languages">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_languages</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_languages"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_languages" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.locale.languages list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – The recipe</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>list of language strings</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.get_services">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_services</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_services"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_services" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.services settings</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – The recipe</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dict of settings</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.get_timezone_settings">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_timezone_settings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_timezone_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_timezone_settings" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.timezone dict</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>append value or empty string</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.keyboard_cmd">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">keyboard_cmd</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#keyboard_cmd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.keyboard_cmd" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the keyboard line with the layout</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The keyboard … line</p></li>
<li><p><strong>settings</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The keyboard layout</p></li>
</ul>
</dd>
</dl>
<p>Using pykickstart to process the line is the best way to make sure it
is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.lang_cmd">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">lang_cmd</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">languages</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#lang_cmd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.lang_cmd" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the lang line with the languages</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The lang … line</p></li>
<li><p><strong>settings</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)"><em>list</em></a>) – The list of languages</p></li>
</ul>
</dd>
</dl>
<p>Using pykickstart to process the line is the best way to make sure it
is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.move_compose_results">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">move_compose_results</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">results_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#move_compose_results"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.move_compose_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Move the final image to the results_dir and cleanup the unneeded compose files</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><em>DataHolder</em></a>) – Build configuration</p></li>
<li><p><strong>results_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Directory to put the results into</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.repo_to_ks">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">repo_to_ks</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">r</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'url'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#repo_to_ks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.repo_to_ks" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a kickstart line with the correct args.
:param r: DNF repository information
:type r: dnf.Repo
:param url: “url” or “baseurl” to use for the baseurl parameter
:type url: str
:returns: kickstart command arguments for url/repo command
:rtype: str</p>
<p>Set url to “baseurl” if it is a repo, leave it as “url” for the installation url.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.services_cmd">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">services_cmd</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#services_cmd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.services_cmd" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the services line with additional services to enable/disable</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The services … line</p></li>
<li><p><strong>settings</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A dict with the list of services to enable and disable</p></li>
</ul>
</dd>
</dl>
<p>Using pykickstart to process the line is the best way to make sure it
is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.start_build">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">start_build</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dnflock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gitlock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compose_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#start_build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.start_build" title="Permalink to this definition">¶</a></dt>
<dd><p>Start the build</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration object</p></li>
<li><p><strong>dnflock</strong> (<em>YumLock</em>) – Lock and YumBase for depsolving</p></li>
<li><p><strong>recipe</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The recipe to build</p></li>
<li><p><strong>compose_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The type of output to create from the recipe</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Unique ID for the build that can be used to track its status</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.test_templates">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">test_templates</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">share_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#test_templates"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.test_templates" title="Permalink to this definition">¶</a></dt>
<dd><p>Try depsolving each of the the templates and report any errors</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of template types and errors</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>List of errors</p>
</dd>
</dl>
<p>Return a list of templates and errors encountered or an empty list</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.timezone_cmd">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">timezone_cmd</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#timezone_cmd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.timezone_cmd" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the timezone line with the settings</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The timezone … line</p></li>
<li><p><strong>settings</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A dict with timezone and/or ntpservers list</p></li>
</ul>
</dd>
</dl>
<p>Using pykickstart to process the line is the best way to make sure it
is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.write_ks_group">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">write_ks_group</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#write_ks_group"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.write_ks_group" title="Permalink to this definition">¶</a></dt>
<dd><p>Write kickstart group entry</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>f</strong> (<em>open file object</em>) – kickstart file object</p></li>
<li><p><strong>group</strong> – A blueprint group dictionary</p></li>
</ul>
</dd>
</dl>
<p>gid is optional</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.write_ks_root">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">write_ks_root</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#write_ks_root"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.write_ks_root" title="Permalink to this definition">¶</a></dt>
<dd><p>Write kickstart root password and sshkey entry</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>f</strong> (<em>open file object</em>) – kickstart file object</p></li>
<li><p><strong>user</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A blueprint user dictionary</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if it wrote a rootpw command to the kickstart</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
</dd>
</dl>
<p>If the entry contains a ssh key, use sshkey to write it
If it contains password, use rootpw to set it</p>
<p>root cannot be used with the user command. So only key and password are supported
for root.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.compose.write_ks_user">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">write_ks_user</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#write_ks_user"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.write_ks_user" title="Permalink to this definition">¶</a></dt>
<dd><p>Write kickstart user and sshkey entry</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>f</strong> (<em>open file object</em>) – kickstart file object</p></li>
<li><p><strong>user</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A blueprint user dictionary</p></li>
</ul>
</dd>
</dl>
<p>If the entry contains a ssh key, use sshkey to write it
All of the user fields are optional, except name, write out a kickstart user entry
with whatever options are relevant.</p>
</dd></dl>

</div>
</div>
<div class="section" id="module-pylorax.api.config">
<span id="pylorax-api-config-module"></span><h2>pylorax.api.config module<a class="headerlink" href="#module-pylorax.api.config" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="pylorax.api.config.ComposerConfig">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.config.</span></code><code class="sig-name descname"><span class="pre">ComposerConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#ComposerConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.config.ComposerConfig" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">configparser.SafeConfigParser</span></code></p>
<dl class="py method">
<dt id="pylorax.api.config.ComposerConfig.get_default">
<code class="sig-name descname"><span class="pre">get_default</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#ComposerConfig.get_default"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.config.ComposerConfig.get_default" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py function">
<dt id="pylorax.api.config.configure">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.config.</span></code><code class="sig-name descname"><span class="pre">configure</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/etc/lorax/composer.conf'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#configure"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.config.configure" title="Permalink to this definition">¶</a></dt>
<dd><p>lorax-composer configuration</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>conf_file</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Path to the config file overriding the default settings</p></li>
<li><p><strong>root_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Directory to prepend to paths, defaults to /</p></li>
<li><p><strong>test_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – Set to True to skip reading conf_file</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.config.make_dnf_dirs">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.config.</span></code><code class="sig-name descname"><span class="pre">make_dnf_dirs</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#make_dnf_dirs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.config.make_dnf_dirs" title="Permalink to this definition">¶</a></dt>
<dd><p>Make any missing dnf directories</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>conf</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – The configuration to use</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>None</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.config.make_queue_dirs">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.config.</span></code><code class="sig-name descname"><span class="pre">make_queue_dirs</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#make_queue_dirs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.config.make_queue_dirs" title="Permalink to this definition">¶</a></dt>
<dd><p>Make any missing queue directories</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>conf</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – The configuration to use</p></li>
<li><p><strong>gid</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Group ID that has access to the queue directories</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>list of errors</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list of str</p>
</dd>
</dl>
</dd></dl>

</div>
<div class="section" id="module-pylorax.api.crossdomain">
<span id="pylorax-api-crossdomain-module"></span><h2>pylorax.api.crossdomain module<a class="headerlink" href="#module-pylorax.api.crossdomain" title="Permalink to this headline">¶</a></h2>
<dl class="py function">
<dt id="pylorax.api.crossdomain.crossdomain">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.crossdomain.</span></code><code class="sig-name descname"><span class="pre">crossdomain</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">origin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">methods</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_age</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">21600</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attach_to_all</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">automatic_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/crossdomain.html#crossdomain"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.crossdomain.crossdomain" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="pylorax-api-dnfbase-module">
<h2>pylorax.api.dnfbase module<a class="headerlink" href="#pylorax-api-dnfbase-module" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-pylorax.api.projects">
<span id="pylorax-api-projects-module"></span><h2>pylorax.api.projects module<a class="headerlink" href="#module-pylorax.api.projects" title="Permalink to this headline">¶</a></h2>
<dl class="py exception">
<dt id="pylorax.api.projects.ProjectsError">
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">ProjectsError</span></code><a class="reference internal" href="_modules/pylorax/api/projects.html#ProjectsError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.ProjectsError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.api_changelog">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">api_changelog</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">changelog</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#api_changelog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.api_changelog" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the changelog to a string</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>changelog</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)"><em>tuple</em></a>) – A list of time, author, string tuples.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The most recent changelog text or “”</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
</dl>
<p>This returns only the most recent changelog entry.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.api_time">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">api_time</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#api_time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.api_time" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert time since epoch to a string</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>t</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Seconds since epoch</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Time string</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.delete_repo_source">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">delete_repo_source</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_glob</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#delete_repo_source"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.delete_repo_source" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a source from a repo file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>source_glob</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – A glob of the repo sources to search</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>None</p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p>ProjectsError if there was a problem</p>
</dd>
</dl>
<p>A repo file may have multiple sources in it, delete only the selected source.
If it is the last one in the file, delete the file.</p>
<p>WARNING: This will delete ANY source, the caller needs to ensure that a system
source_name isn’t passed to it.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.dep_evra">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">dep_evra</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dep</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#dep_evra"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.dep_evra" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the epoch:version-release.arch for the dep</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dep</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – dependency dict</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>epoch:version-release.arch</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.dep_nevra">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">dep_nevra</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dep</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#dep_nevra"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.dep_nevra" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the name-epoch:version-release.arch</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.dnf_repo_to_file_repo">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">dnf_repo_to_file_repo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#dnf_repo_to_file_repo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.dnf_repo_to_file_repo" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a string representation of a DNF Repo object suitable for writing to a .repo file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>repo</strong> (<em>dnf.RepoDict</em>) – DNF Repository</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A string</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
</dl>
<p>The DNF Repo.dump() function does not produce a string that can be used as a dnf .repo file,
it ouputs baseurl and gpgkey as python lists which DNF cannot read. So do this manually with
only the attributes we care about.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.estimate_size">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">estimate_size</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">packages</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">block_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">6144</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#estimate_size"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.estimate_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Estimate the installed size of a package list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>packages</strong> (<em>list of hawkey.Package objects</em>) – The packages to be installed</p></li>
<li><p><strong>block_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – The block size to use for rounding up file sizes.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The estimated size of installed packages</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)">int</a></p>
</dd>
</dl>
<p>Estimating actual requirements is difficult without the actual file sizes, which
dnf doesn’t provide access to. So use the file count and block size to estimate
a minimum size for each package.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.get_repo_sources">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">get_repo_sources</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_glob</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#get_repo_sources"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.get_repo_sources" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of sources from a directory of yum repositories</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>source_glob</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – A glob to use to match the source files, including full path</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A list of the source ids in all of the matching files</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list of str</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.get_source_ids">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">get_source_ids</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#get_source_ids"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.get_source_ids" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of the source ids in a file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>source_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Full path and filename of the source (yum repo) file</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A list of source id strings</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list of str</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.modules_info">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">modules_info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module_names</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#modules_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.modules_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Return details about a module, including dependencies</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
<li><p><strong>module_names</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Names of the modules to get info about</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of dicts with module details and dependencies.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list of dicts</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.modules_list">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">modules_list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module_names</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#modules_list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.modules_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of modules</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
<li><p><strong>offset</strong> – Number of modules to skip</p></li>
<li><p><strong>limit</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Maximum number of modules to return</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of module information and total count</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>tuple of a list of dicts and an Int</p>
</dd>
</dl>
<p>Modules don’t exist in RHEL7 so this only returns projects
and sets the type to “rpm”</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.pkg_to_build">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">pkg_to_build</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#pkg_to_build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.pkg_to_build" title="Permalink to this definition">¶</a></dt>
<dd><p>Extract the build details from a hawkey.Package object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pkg</strong> (<em>hawkey.Package</em>) – hawkey.Package object with package details</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dict with the build details, epoch, release, arch, build_time, changelog, …</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
</dl>
<p>metadata entries are hard-coded to {}</p>
<p>Note that this only returns the build dict, it does not include the name, description, etc.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.pkg_to_dep">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">pkg_to_dep</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#pkg_to_dep"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.pkg_to_dep" title="Permalink to this definition">¶</a></dt>
<dd><p>Extract the info from a hawkey.Package object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pkg</strong> (<em>hawkey.Package</em>) – A hawkey.Package object</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dict with name, epoch, version, release, arch</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.pkg_to_project">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">pkg_to_project</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#pkg_to_project"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.pkg_to_project" title="Permalink to this definition">¶</a></dt>
<dd><p>Extract the details from a hawkey.Package object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pkgs</strong> (<em>hawkey.Package</em>) – hawkey.Package object with package details</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dict with the name, summary, description, and url.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
</dl>
<p>upstream_vcs is hard-coded to UPSTREAM_VCS</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.pkg_to_project_info">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">pkg_to_project_info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#pkg_to_project_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.pkg_to_project_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Extract the details from a hawkey.Package object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pkg</strong> (<em>hawkey.Package</em>) – hawkey.Package object with package details</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dict with the project details, as well as epoch, release, arch, build_time, changelog, …</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
</dl>
<p>metadata entries are hard-coded to {}</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.proj_to_module">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">proj_to_module</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#proj_to_module"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.proj_to_module" title="Permalink to this definition">¶</a></dt>
<dd><p>Extract the name from a project_info dict</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pkg</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – dict with package details</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dict with name, and group_type</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
</dl>
<p>group_type is hard-coded to “rpm”</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.projects_depsolve">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">projects_depsolve</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">projects</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_depsolve"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.projects_depsolve" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the dependencies for a list of projects</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
<li><p><strong>projects</strong> (<em>List of Strings</em>) – The projects to find the dependencies for</p></li>
<li><p><strong>groups</strong> (<em>List of str</em>) – The groups to include in dependency solving</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>NEVRA’s of the project and its dependencies</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list of dicts</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>ProjectsError if there was a problem installing something</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.projects_depsolve_with_size">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">projects_depsolve_with_size</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">projects</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_core</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_depsolve_with_size"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.projects_depsolve_with_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the dependencies and installed size for a list of projects</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
<li><p><strong>project_names</strong> (<em>List of Strings</em>) – The projects to find the dependencies for</p></li>
<li><p><strong>groups</strong> (<em>List of str</em>) – The groups to include in dependency solving</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>installed size and a list of NEVRA’s of the project and its dependencies</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>tuple of (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)">int</a>, list of dicts)</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>ProjectsError if there was a problem installing something</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.projects_info">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">projects_info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_names</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.projects_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Return details about specific projects</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
<li><p><strong>project_names</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – List of names of projects to get info about</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of project info dicts with pkg_to_project as well as epoch, version, release, etc.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list of dicts</p>
</dd>
</dl>
<p>If project_names is None it will return the full list of available packages</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.projects_list">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">projects_list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.projects_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of projects</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of project info dicts with name, summary, description, homepage, upstream_vcs</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list of dicts</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.repo_to_source">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">repo_to_source</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">system_source</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#repo_to_source"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.repo_to_source" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a Weldr Source dict created from the DNF Repository</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>dnf.RepoDict</em>) – DNF Repository</p></li>
<li><p><strong>system_source</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – True if this source is an immutable system source</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dict with Weldr Source fields filled in</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;check_gpg&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
  <span class="s2">&quot;check_ssl&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
  <span class="s2">&quot;gpgkey_url&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="s2">&quot;file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64&quot;</span>
  <span class="p">],</span>
  <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;fedora&quot;</span><span class="p">,</span>
  <span class="s2">&quot;proxy&quot;</span><span class="p">:</span> <span class="s2">&quot;http://proxy.brianlane.com:8123&quot;</span><span class="p">,</span>
  <span class="s2">&quot;system&quot;</span><span class="p">:</span> <span class="n">true</span>
  <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;yum-metalink&quot;</span><span class="p">,</span>
  <span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="s2">&quot;https://mirrors.fedoraproject.org/metalink?repo=fedora-28&amp;arch=x86_64&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.projects.source_to_repo">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">source_to_repo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dnf_conf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#source_to_repo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.source_to_repo" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a dnf Repo object created from a source dict</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>source</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A Weldr source dict</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dnf Repo object</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>dnf.Repo</p>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;check_gpg&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
  <span class="s2">&quot;check_ssl&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
  <span class="s2">&quot;gpgkey_urls&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="s2">&quot;file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64&quot;</span>
  <span class="p">],</span>
  <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;fedora&quot;</span><span class="p">,</span>
  <span class="s2">&quot;proxy&quot;</span><span class="p">:</span> <span class="s2">&quot;http://proxy.brianlane.com:8123&quot;</span><span class="p">,</span>
  <span class="s2">&quot;system&quot;</span><span class="p">:</span> <span class="kc">True</span>
  <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;yum-metalink&quot;</span><span class="p">,</span>
  <span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="s2">&quot;https://mirrors.fedoraproject.org/metalink?repo=fedora-28&amp;arch=x86_64&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</dd></dl>

</div>
<div class="section" id="module-pylorax.api.queue">
<span id="pylorax-api-queue-module"></span><h2>pylorax.api.queue module<a class="headerlink" href="#module-pylorax.api.queue" title="Permalink to this headline">¶</a></h2>
<p>Functions to monitor compose queue and run anaconda</p>
<dl class="py function">
<dt id="pylorax.api.queue.build_status">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">build_status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status_filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#build_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.build_status" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the details of finished or failed builds</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
<li><p><strong>status_filter</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – What builds to return. None == all, “FINISHED”, or “FAILED”</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A list of the build details (from compose_details)</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list of dicts</p>
</dd>
</dl>
<p>This returns a list of build details for each of the matching builds on the
system. It does not return the status of builds that have not been finished.
Use queue_status() for those.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.check_queues">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">check_queues</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#check_queues"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.check_queues" title="Permalink to this definition">¶</a></dt>
<dd><p>Check to make sure the new and run queue symlinks are correct</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cfg</strong> (<a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><em>DataHolder</em></a>) – Configuration settings</p>
</dd>
</dl>
<p>Also check all of the existing results and make sure any with WAITING
set in STATUS have a symlink in queue/new/</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.compose_detail">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">compose_detail</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">results_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#compose_detail"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.compose_detail" title="Permalink to this definition">¶</a></dt>
<dd><p>Return details about the build.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>results_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The directory containing the metadata and results for the build</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dictionary with details about the compose</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>IOError if it cannot read the directory, STATUS, or blueprint file.</p>
</dd>
</dl>
<p>The following details are included in the dict:</p>
<ul class="simple">
<li><p>id - The uuid of the comoposition</p></li>
<li><p>queue_status - The final status of the composition (FINISHED or FAILED)</p></li>
<li><p>compose_type - The type of output generated (tar, iso, etc.)</p></li>
<li><p>blueprint - Blueprint name</p></li>
<li><p>version - Blueprint version</p></li>
<li><p>image_size - Size of the image, if finished. 0 otherwise.</p></li>
</ul>
<p>Various timestamps are also included in the dict.  These are all Unix UTC timestamps.
It is possible for these timestamps to not always exist, in which case they will be
None in Python (or null in JSON).  The following timestamps are included:</p>
<ul class="simple">
<li><p>job_created - When the user submitted the compose</p></li>
<li><p>job_started - Anaconda started running</p></li>
<li><p>job_finished - Job entered FINISHED or FAILED state</p></li>
</ul>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.get_compose_type">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">get_compose_type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">results_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#get_compose_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.get_compose_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the type of composition.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>results_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The directory containing the metadata and results for the build</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The type of compose (eg. ‘tar’)</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>RuntimeError if no kickstart template can be found.</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.get_image_name">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">get_image_name</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#get_image_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.get_image_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the filename and full path of the build’s image file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The image filename and full path</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>tuple of strings</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>RuntimeError if there was a problem (eg. invalid uuid, missing config file)</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.make_compose">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">make_compose</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">results_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#make_compose"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.make_compose" title="Permalink to this definition">¶</a></dt>
<dd><p>Run anaconda with the final-kickstart.ks from results_dir</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><em>DataHolder</em></a>) – Configuration settings</p></li>
<li><p><strong>results_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The directory containing the metadata and results for the build</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Nothing</p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p>May raise various exceptions</p>
</dd>
</dl>
<p>This takes the final-kickstart.ks, and the settings in config.toml and runs Anaconda
in no-virt mode (directly on the host operating system). Exceptions should be caught
at the higer level.</p>
<p>If there is a failure, the build artifacts will be cleaned up, and any logs will be
moved into logs/anaconda/ and their ownership will be set to the user from the cfg
object.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.monitor">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">monitor</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#monitor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.monitor" title="Permalink to this definition">¶</a></dt>
<dd><p>Monitor the queue for new compose requests</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cfg</strong> (<a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><em>DataHolder</em></a>) – Configuration settings</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Does not return</p>
</dd>
</dl>
<p>The queue has 2 subdirectories, new and run. When a compose is ready to be run
a symlink to the uniquely named results directory should be placed in ./queue/new/</p>
<p>When the it is ready to be run (it is checked every 30 seconds or after a previous
compose is finished) the symlink will be moved into ./queue/run/ and a STATUS file
will be created in the results directory.</p>
<p>STATUS can contain one of: WAITING, RUNNING, FINISHED, FAILED</p>
<p>If the system is restarted while a compose is running it will move any old symlinks
from ./queue/run/ to ./queue/new/ and rerun them.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.queue_status">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">queue_status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#queue_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.queue_status" title="Permalink to this definition">¶</a></dt>
<dd><p>Return details about what is in the queue.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A list of the new composes, and a list of the running composes</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
</dl>
<p>This returns a dict with 2 lists. “new” is the list of uuids that are waiting to be built,
and “run” has the uuids that are being built (currently limited to 1 at a time).</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.start_queue_monitor">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">start_queue_monitor</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#start_queue_monitor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.start_queue_monitor" title="Permalink to this definition">¶</a></dt>
<dd><p>Start the queue monitor as a mp process</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
<li><p><strong>uid</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – User ID that owns the queue</p></li>
<li><p><strong>gid</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Group ID that owns the queue</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>None</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.uuid_cancel">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_cancel</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_cancel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_cancel" title="Permalink to this definition">¶</a></dt>
<dd><p>Cancel a build and delete its results</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if it was canceled and deleted</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
</dd>
</dl>
<p>Only call this if the build status is WAITING or RUNNING</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.uuid_delete">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete all of the results from a compose</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if it was deleted</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>This will raise an error if the delete failed</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.uuid_image">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_image</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_image" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the filename and full path of the build’s image file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The image filename and full path</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>tuple of strings</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>RuntimeError if there was a problem (eg. invalid uuid, missing config file)</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.uuid_info">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Return information about the composition</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>dictionary of information about the composition or None</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>RuntimeError if there was a problem</p>
</dd>
</dl>
<p>This will return a dict with the following fields populated:</p>
<ul class="simple">
<li><p>id - The uuid of the comoposition</p></li>
<li><p>config - containing the configuration settings used to run Anaconda</p></li>
<li><p>blueprint - The depsolved blueprint used to generate the kickstart</p></li>
<li><p>commit - The (local) git commit hash for the blueprint used</p></li>
<li><p>deps - The NEVRA of all of the dependencies used in the composition</p></li>
<li><p>compose_type - The type of output generated (tar, iso, etc.)</p></li>
<li><p>queue_status - The final status of the composition (FINISHED or FAILED)</p></li>
</ul>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.uuid_log">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_log</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1024</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_log"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_log" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <cite>size</cite> kbytes from the end of the anaconda.log</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
<li><p><strong>size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Number of kbytes to read. Default is 1024</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Up to <cite>size</cite> kbytes from the end of the log</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>RuntimeError if there was a problem (eg. no log file available)</p>
</dd>
</dl>
<p>This function tries to return lines from the end of the log, it will
attempt to start on a line boundry, and may return less than <cite>size</cite> kbytes.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.uuid_status">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_status" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the details of a specific UUID compose</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Details about the build</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
</dd>
</dl>
<p>Returns the same dict as <cite>compose_details()</cite></p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.queue.uuid_tar">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_tar</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_tar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_tar" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a tar of the build data</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
<li><p><strong>metadata</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – Set to true to include all the metadata needed to reproduce the build</p></li>
<li><p><strong>image</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – Set to true to include the output image</p></li>
<li><p><strong>logs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – Set to true to include the logs from the build</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A stream of bytes from tar</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>A generator</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>RuntimeError if there was a problem (eg. missing config file)</p>
</dd>
</dl>
<p>This yields an uncompressed tar’s data to the caller. It includes
the selected data to the caller by returning the Popen stdout from the tar process.</p>
</dd></dl>

</div>
<div class="section" id="module-pylorax.api.recipes">
<span id="pylorax-api-recipes-module"></span><h2>pylorax.api.recipes module<a class="headerlink" href="#module-pylorax.api.recipes" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="pylorax.api.recipes.CommitDetails">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">CommitDetails</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">commit</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">revision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#CommitDetails"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.CommitDetails" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><code class="xref py py-class docutils literal notranslate"><span class="pre">pylorax.base.DataHolder</span></code></a></p>
</dd></dl>

<dl class="py exception">
<dt id="pylorax.api.recipes.CommitTimeValError">
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">CommitTimeValError</span></code><a class="reference internal" href="_modules/pylorax/api/recipes.html#CommitTimeValError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.CommitTimeValError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.NewRecipeGit">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">NewRecipeGit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">toml_dict</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#NewRecipeGit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.NewRecipeGit" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a RecipeGit object from fields in a TOML dict</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>rpmname</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Name of the rpm to create, also used as the prefix name in the tar archive</p></li>
<li><p><strong>rpmversion</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Version of the rpm, eg. “1.0.0”</p></li>
<li><p><strong>rpmrelease</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Release of the rpm, eg. “1”</p></li>
<li><p><strong>summary</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Summary string for the rpm</p></li>
<li><p><strong>repo</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – URL of the get repo to clone and create the archive from</p></li>
<li><p><strong>ref</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Git reference to check out. eg. origin/branch-name, git tag, or git commit hash</p></li>
<li><p><strong>destination</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Path to install the / of the git repo at when installing the rpm</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A populated RecipeGit object</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.RecipeGit" title="pylorax.api.recipes.RecipeGit">RecipeGit</a></p>
</dd>
</dl>
<p>The TOML should look like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">repos</span><span class="o">.</span><span class="n">git</span><span class="p">]]</span>
<span class="n">rpmname</span><span class="o">=</span><span class="s2">&quot;server-config&quot;</span>
<span class="n">rpmversion</span><span class="o">=</span><span class="s2">&quot;1.0&quot;</span>
<span class="n">rpmrelease</span><span class="o">=</span><span class="s2">&quot;1&quot;</span>
<span class="n">summary</span><span class="o">=</span><span class="s2">&quot;Setup files for server deployment&quot;</span>
<span class="n">repo</span><span class="o">=</span><span class="s2">&quot;PATH OF GIT REPO TO CLONE&quot;</span>
<span class="n">ref</span><span class="o">=</span><span class="s2">&quot;v1.0&quot;</span>
<span class="n">destination</span><span class="o">=</span><span class="s2">&quot;/opt/server/&quot;</span>
</pre></div>
</div>
<p>Note that the repo path supports anything that git supports, <a class="reference external" href="file://">file://</a>, <a class="reference external" href="https://">https://</a>, <a class="reference external" href="http://">http://</a></p>
<p>Currently there is no support for authentication</p>
</dd></dl>

<dl class="py class">
<dt id="pylorax.api.recipes.Recipe">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">Recipe</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">modules</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">packages</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customizations</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gitrepos</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
<p>A Recipe of package and modules</p>
<p>This is a subclass of dict that enforces the constructor arguments
and adds a .filename property to return the recipe’s filename,
and a .toml() function to return the recipe as a TOML string.</p>
<dl class="py method">
<dt id="pylorax.api.recipes.Recipe.bump_version">
<code class="sig-name descname"><span class="pre">bump_version</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">old_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe.bump_version"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe.bump_version" title="Permalink to this definition">¶</a></dt>
<dd><p>semver recipe version number bump</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>old_version</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – An optional old version number</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The new version number or None</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>ValueError</p>
</dd>
</dl>
<p>If neither have a version, 0.0.1 is returned
If there is no old version the new version is checked and returned
If there is no new version, but there is a old one, bump its patch level
If the old and new versions are the same, bump the patch level
If they are different, check and return the new version</p>
</dd></dl>

<dl class="py method">
<dt id="pylorax.api.recipes.Recipe.filename">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">filename</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.filename" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the Recipe’s filename</p>
<p>Replaces spaces in the name with ‘-‘ and appends .toml</p>
</dd></dl>

<dl class="py method">
<dt id="pylorax.api.recipes.Recipe.freeze">
<code class="sig-name descname"><span class="pre">freeze</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deps</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe.freeze"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe.freeze" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a new Recipe with full module and package NEVRA</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>deps</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)"><em>list</em></a><em>(</em>) – A list of dependency NEVRA to use to fill in the modules and packages</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A new Recipe object</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pylorax.api.recipes.Recipe.group_names">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">group_names</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.group_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the names of the groups.  Groups do not have versions.</p>
</dd></dl>

<dl class="py method">
<dt id="pylorax.api.recipes.Recipe.module_names">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">module_names</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.module_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the names of the modules</p>
</dd></dl>

<dl class="py method">
<dt id="pylorax.api.recipes.Recipe.module_nver">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">module_nver</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.module_nver" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the names and version globs of the modules</p>
</dd></dl>

<dl class="py method">
<dt id="pylorax.api.recipes.Recipe.package_names">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">package_names</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.package_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the names of the packages</p>
</dd></dl>

<dl class="py method">
<dt id="pylorax.api.recipes.Recipe.package_nver">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">package_nver</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.package_nver" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the names and version globs of the packages</p>
</dd></dl>

<dl class="py method">
<dt id="pylorax.api.recipes.Recipe.toml">
<code class="sig-name descname"><span class="pre">toml</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe.toml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe.toml" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the Recipe in TOML format</p>
</dd></dl>

</dd></dl>

<dl class="py exception">
<dt id="pylorax.api.recipes.RecipeError">
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipeError</span></code><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
</dd></dl>

<dl class="py exception">
<dt id="pylorax.api.recipes.RecipeFileError">
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipeFileError</span></code><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeFileError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeFileError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
</dd></dl>

<dl class="py class">
<dt id="pylorax.api.recipes.RecipeGit">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipeGit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rpmname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rpmversion</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rpmrelease</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">destination</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeGit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeGit" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
</dd></dl>

<dl class="py class">
<dt id="pylorax.api.recipes.RecipeGroup">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipeGroup</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeGroup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeGroup" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
</dd></dl>

<dl class="py class">
<dt id="pylorax.api.recipes.RecipeModule">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipeModule</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeModule"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeModule" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
</dd></dl>

<dl class="py class">
<dt id="pylorax.api.recipes.RecipePackage">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipePackage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipePackage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipePackage" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pylorax.api.recipes.RecipeModule" title="pylorax.api.recipes.RecipeModule"><code class="xref py py-class docutils literal notranslate"><span class="pre">pylorax.api.recipes.RecipeModule</span></code></a></p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.check_list_case">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">check_list_case</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expected_keys</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_keys</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#check_list_case"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.check_list_case" title="Permalink to this definition">¶</a></dt>
<dd><p>Check the case of the recipe keys</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>expected_keys</strong> (<em>list of str</em>) – A list of expected key strings</p></li>
<li><p><strong>recipe_keys</strong> (<em>list of str</em>) – A list of the recipe’s key strings</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>list of errors</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list of str</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.check_recipe_dict">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">check_recipe_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe_dict</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#check_recipe_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.check_recipe_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Check a dict before using it to create a new Recipe</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recipe_dict</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A plain dict of the recipe</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if dict is ok</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>RecipeError</p>
</dd>
</dl>
<p>This checks a dict to make sure required fields are present,
that optional fields are correct, and that other optional fields
are of the correct format, when included.</p>
<p>This collects all of the errors and returns a single RecipeError with
a string that can be presented to users.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.check_required_list">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">check_required_list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lst</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#check_required_list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.check_required_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Check a list of dicts for required fields</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>lst</strong> (<em>list of dict</em>) – A list of dicts with fields</p></li>
<li><p><strong>fields</strong> (<em>list of str</em>) – A list of field name strings</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A list of error strings</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list of str</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.commit_recipe">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">commit_recipe</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#commit_recipe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.commit_recipe" title="Permalink to this definition">¶</a></dt>
<dd><p>Commit a recipe to a branch</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – Recipe to commit</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>OId of the new commit</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Git.OId</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.commit_recipe_directory">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">commit_recipe_directory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">directory</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#commit_recipe_directory"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.commit_recipe_directory" title="Permalink to this definition">¶</a></dt>
<dd><p>Commit all *.toml files from a directory, if they aren’t already in git.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>directory</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The directory of *.toml recipes to commit</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>None</p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p>Can raise errors from Ggit or RecipeFileError</p>
</dd>
</dl>
<p>Files with Toml or RecipeFileErrors will be skipped, and the remainder will
be tried.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.commit_recipe_file">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">commit_recipe_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#commit_recipe_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.commit_recipe_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Commit a recipe file to a branch</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Path to the recipe file to commit</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>OId of the new commit</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Git.OId</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit or RecipeFileError</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.customizations_diff">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">customizations_diff</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">old_recipe</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#customizations_diff"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.customizations_diff" title="Permalink to this definition">¶</a></dt>
<dd><p>Diff the customizations sections from two versions of a recipe</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.delete_file">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">delete_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#delete_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.delete_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a file from a branch.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to delete</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>OId of the new commit</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Git.OId</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.delete_recipe">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">delete_recipe</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#delete_recipe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.delete_recipe" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a recipe from a branch.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to delete</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>OId of the new commit</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Git.OId</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.diff_lists">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">diff_lists</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">old_items</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_items</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#diff_lists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.diff_lists" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the differences between two lists of dicts.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>title</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Title of the entry</p></li>
<li><p><strong>field</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Field to use as the key for comparisons</p></li>
<li><p><strong>old_items</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)"><em>list</em></a><em>(</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a><em>)</em>) – List of item dicts with “name” field</p></li>
<li><p><strong>new_items</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)"><em>list</em></a><em>(</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a><em>)</em>) – List of item dicts with “name” field</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of diff dicts with old/new entries</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a>)</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.find_commit_tag">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">find_commit_tag</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#find_commit_tag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.find_commit_tag" title="Permalink to this definition">¶</a></dt>
<dd><p>Find the tag that matches the commit_id</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to revert</p></li>
<li><p><strong>commit_id</strong> (<em>Git.OId</em>) – The commit id to check</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The tag or None if there isn’t one</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
</dd>
</dl>
<p>There should be only 1 tag pointing to a commit, but there may not
be a tag at all.</p>
<p>The tag will look like: ‘refs/tags/&lt;branch&gt;/&lt;filename&gt;/r&lt;revision&gt;’</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.find_field_value">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">find_field_value</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lst</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#find_field_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.find_field_value" title="Permalink to this definition">¶</a></dt>
<dd><p>Find a field matching value in the list of dicts.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>field</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – field to search for</p></li>
<li><p><strong>value</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – value to match in the field</p></li>
<li><p><strong>lst</strong> (<em>list of dict</em>) – List of dict’s with field</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>First dict with matching field:value, or None</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
</dd>
</dl>
<p>Used to return a specific entry from a list that looks like this:</p>
<p>[{“name”: “one”, “attr”: “green”}, …]</p>
<p>find_field_value(“name”, “one”, lst) will return the matching dict.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.find_name">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">find_name</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lst</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#find_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.find_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Find the dict matching the name in a list and return it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Name to search for</p></li>
<li><p><strong>lst</strong> (<em>list of dict</em>) – List of dict’s with “name” field</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>First dict with matching name, or None</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
</dd>
</dl>
<p>This is just a wrapper for find_field_value with field set to “name”</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.find_recipe_obj">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">find_recipe_obj</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#find_recipe_obj"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.find_recipe_obj" title="Permalink to this definition">¶</a></dt>
<dd><p>Find a recipe object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>path</strong> (<em>list of str</em>) – A list of dict field names</p></li>
<li><p><strong>recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – The recipe to search</p></li>
<li><p><strong>default</strong> (<em>Any</em>) – The value to return if it is not found</p></li>
</ul>
</dd>
</dl>
<p>Return the object found by applying the path to the dicts in the recipe, or
return the default if it doesn’t exist.</p>
<p>eg. {“customizations”: {“hostname”: “foo”, “users”: […]}}</p>
<p>find_recipe_obj([“customizations”, “hostname”], recipe, “”)</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.get_commit_details">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">get_commit_details</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">commit</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">revision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#get_commit_details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.get_commit_details" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the details about a specific commit.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>commit</strong> (<em>Git.Commit</em>) – The commit to get details from</p></li>
<li><p><strong>revision</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Optional commit revision</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Details about the commit</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.CommitDetails" title="pylorax.api.recipes.CommitDetails">CommitDetails</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>CommitTimeValError or Ggit exceptions</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.get_revision_from_tag">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">get_revision_from_tag</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#get_revision_from_tag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.get_revision_from_tag" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the revision number from a tag</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>tag</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The tag to exract the revision from</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The integer revision or None</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
</dd>
</dl>
<p>The revision is the part after the r in ‘branch/filename/rXXX’</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.gfile">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">gfile</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#gfile"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.gfile" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert a string path to GFile for use with Git</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.head_commit">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">head_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#head_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.head_commit" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the branch’s HEAD Commit Object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Branch’s head commit</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Git.Commit</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.is_commit_tag">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">is_commit_tag</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#is_commit_tag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.is_commit_tag" title="Permalink to this definition">¶</a></dt>
<dd><p>Check to see if a tag points to a specific commit.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>commit_id</strong> (<em>Git.OId</em>) – The commit id to check</p></li>
<li><p><strong>tag</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The tag to check</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the tag points to the commit, False otherwise</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.is_parent_diff">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">is_parent_diff</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tree</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#is_parent_diff"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.is_parent_diff" title="Permalink to this definition">¶</a></dt>
<dd><p>Check to see if the commit is different from its parents</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to revert</p></li>
<li><p><strong>tree</strong> (<em>Git.Tree</em>) – The commit’s tree</p></li>
<li><p><strong>parent</strong> (<em>Git.Commit</em>) – The commit’s parent commit</p></li>
</ul>
</dd>
<dt class="field-even">Retuns</dt>
<dd class="field-even"><p>True if filename in the commit is different from its parents</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.list_branch_files">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">list_branch_files</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#list_branch_files"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.list_branch_files" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a sorted list of the files on the branch HEAD</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A sorted list of the filenames</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a>)</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.list_commit_files">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">list_commit_files</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#list_commit_files"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.list_commit_files" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a sorted list of the files on a commit</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The commit hash to list</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A sorted list of the filenames</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a>)</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.list_commits">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">list_commits</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#list_commits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.list_commits" title="Permalink to this definition">¶</a></dt>
<dd><p>List the commit history of a file on a branch.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to revert</p></li>
<li><p><strong>limit</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Number of commits to return (0=all)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A list of commit details</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a>(<a class="reference internal" href="#pylorax.api.recipes.CommitDetails" title="pylorax.api.recipes.CommitDetails">CommitDetails</a>)</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.open_or_create_repo">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">open_or_create_repo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#open_or_create_repo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.open_or_create_repo" title="Permalink to this definition">¶</a></dt>
<dd><p>Open an existing repo, or create a new one</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>path</strong> (<em>string</em>) – path to recipe directory</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A repository object</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Git.Repository</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
<p>A bare git repo will be created in the git directory of the specified path.
If a repo already exists it will be opened and returned instead of
creating a new one.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.prepare_commit">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">prepare_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">builder</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#prepare_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.prepare_commit" title="Permalink to this definition">¶</a></dt>
<dd><p>Prepare for a commit</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>builder</strong> (<a class="reference internal" href="pylorax.html#pylorax.treebuilder.TreeBuilder" title="pylorax.treebuilder.TreeBuilder"><em>TreeBuilder</em></a>) – instance of TreeBuilder</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>(Tree, Sig, Ref)</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)">tuple</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.read_commit">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">read_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.read_commit" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the contents of a file on a specific branch or commit.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to read</p></li>
<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Optional commit hash</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The commit id, and the contents of the commit</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)">tuple</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a>)</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
<p>If no commit is passed the master:filename is returned, otherwise it will be
commit:filename</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.read_commit_spec">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">read_commit_spec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_commit_spec"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.read_commit_spec" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the raw content of the blob specified by the spec</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>spec</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Git revparse spec</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Contents of the commit</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
<p>eg. To read the README file from master the spec is “master:README”</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.read_recipe_and_id">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">read_recipe_and_id</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_recipe_and_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.read_recipe_and_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Read a recipe commit and its id from git</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to read</p></li>
<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Optional commit hash</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The commit id, and a Recipe object</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)">tuple</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a>, <a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a>)</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
<p>If no commit is passed the master:filename is returned, otherwise it will be
commit:filename</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.read_recipe_commit">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">read_recipe_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_recipe_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.read_recipe_commit" title="Permalink to this definition">¶</a></dt>
<dd><p>Read a recipe commit from git and return a Recipe object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to read</p></li>
<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Optional commit hash</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A Recipe object</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
<p>If no commit is passed the master:filename is returned, otherwise it will be
commit:filename</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.recipe_diff">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">recipe_diff</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">old_recipe</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_diff"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_diff" title="Permalink to this definition">¶</a></dt>
<dd><p>Diff two versions of a recipe</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>old_recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – The old version of the recipe</p></li>
<li><p><strong>new_recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – The new version of the recipe</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A list of diff dict entries with old/new</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a>)</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.recipe_filename">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">recipe_filename</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_filename"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_filename" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the toml filename for a recipe</p>
<p>Replaces spaces with ‘-‘ and appends ‘.toml’</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.recipe_from_dict">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">recipe_from_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe_dict</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_from_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_from_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a Recipe object from a plain dict.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recipe_dict</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A plain dict of the recipe</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A Recipe object</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>RecipeError</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.recipe_from_file">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">recipe_from_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_from_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_from_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a recipe file as a Recipe object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recipe_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Path to the recipe fila</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A Recipe object</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.recipe_from_toml">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">recipe_from_toml</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe_str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_from_toml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_from_toml" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a Recipe object from a toml string.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>recipe_str</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The Recipe TOML string</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A Recipe object</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>TomlError</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.repo_file_exists">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">repo_file_exists</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#repo_file_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.repo_file_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Return True if the filename exists on the branch</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Filename to check</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the filename exists on the HEAD of the branch, False otherwise.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.revert_file">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">revert_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#revert_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.revert_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Revert the contents of a file to that of a previous commit</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to revert</p></li>
<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Commit hash</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>OId of the new commit</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Git.OId</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.revert_recipe">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">revert_recipe</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#revert_recipe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.revert_recipe" title="Permalink to this definition">¶</a></dt>
<dd><p>Revert the contents of a recipe to that of a previous commit</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to revert</p></li>
<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Commit hash</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>OId of the new commit</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Git.OId</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.tag_file_commit">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">tag_file_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#tag_file_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.tag_file_commit" title="Permalink to this definition">¶</a></dt>
<dd><p>Tag a file’s most recent commit</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Filename to tag</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Tag id or None if it failed.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Git.OId</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
<p>This uses git tags, of the form <cite>refs/tags/&lt;branch&gt;/&lt;filename&gt;/r&lt;revision&gt;</cite>
Only the most recent recipe commit can be tagged to prevent out of order tagging.
Revisions start at 1 and increment for each new commit that is tagged.
If the commit has already been tagged it will return false.</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.tag_recipe_commit">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">tag_recipe_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#tag_recipe_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.tag_recipe_commit" title="Permalink to this definition">¶</a></dt>
<dd><p>Tag a file’s most recent commit</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to tag</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Tag id or None if it failed.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Git.OId</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
<p>Uses tag_file_commit()</p>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.recipes.write_commit">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">write_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#write_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.write_commit" title="Permalink to this definition">¶</a></dt>
<dd><p>Make a new commit to a repository’s branch</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – full path of the file to add</p></li>
<li><p><strong>message</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The commit message</p></li>
<li><p><strong>content</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The data to write</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>OId of the new commit</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Git.OId</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>Can raise errors from Ggit</p>
</dd>
</dl>
</dd></dl>

</div>
<div class="section" id="module-pylorax.api.server">
<span id="pylorax-api-server-module"></span><h2>pylorax.api.server module<a class="headerlink" href="#module-pylorax.api.server" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="pylorax.api.server.GitLock">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.server.</span></code><code class="sig-name descname"><span class="pre">GitLock</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dir</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pylorax.api.server.GitLock" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
<dl class="py method">
<dt id="pylorax.api.server.GitLock.dir">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">dir</span></code><a class="headerlink" href="#pylorax.api.server.GitLock.dir" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 2</p>
</dd></dl>

<dl class="py method">
<dt id="pylorax.api.server.GitLock.lock">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">lock</span></code><a class="headerlink" href="#pylorax.api.server.GitLock.lock" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 1</p>
</dd></dl>

<dl class="py method">
<dt id="pylorax.api.server.GitLock.repo">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">repo</span></code><a class="headerlink" href="#pylorax.api.server.GitLock.repo" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for field number 0</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-pylorax.api.v0">
<span id="pylorax-api-v0-module"></span><h2>pylorax.api.v0 module<a class="headerlink" href="#module-pylorax.api.v0" title="Permalink to this headline">¶</a></h2>
<p>Setup v0 of the API server</p>
<p>v0_api() must be called to setup the API routes for Flask</p>
<div class="section" id="status-responses">
<h3>Status Responses<a class="headerlink" href="#status-responses" title="Permalink to this headline">¶</a></h3>
<p>Some requests only return a status/error response.</p>
<blockquote>
<div><p>The response will be a status response with <cite>status</cite> set to true, or an
error response with it set to false and an error message included.</p>
<p>Example response:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Error response:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;ggit-error: Failed to remove entry. File isn&#39;t in the tree - jboss.toml (-1)&quot;</span><span class="p">]</span>
  <span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="n">false</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-routes">
<h3>API Routes<a class="headerlink" href="#api-routes" title="Permalink to this headline">¶</a></h3>
<p>All of the blueprints routes support the optional <cite>branch</cite> argument. If it is not
used then the API will use the <cite>master</cite> branch for blueprints. If you want to create
a new branch use the <cite>new</cite> or <cite>workspace</cite> routes with ?branch=&lt;branch-name&gt; to
store the new blueprint on the new branch.</p>
<div class="section" id="api-v0-blueprints-list">
<h4><cite>/api/v0/blueprints/list</cite><a class="headerlink" href="#api-v0-blueprints-list" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>List the available blueprints:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
  <span class="s2">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="s2">&quot;atlas&quot;</span><span class="p">,</span>
    <span class="s2">&quot;development&quot;</span><span class="p">,</span>
    <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
    <span class="s2">&quot;http-server&quot;</span><span class="p">,</span>
    <span class="s2">&quot;jboss&quot;</span><span class="p">,</span>
    <span class="s2">&quot;kubernetes&quot;</span> <span class="p">],</span>
  <span class="s2">&quot;total&quot;</span><span class="p">:</span> <span class="mi">6</span> <span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-blueprints-info-blueprint-names-format-json-toml">
<h4><cite>/api/v0/blueprints/info/&lt;blueprint_names&gt;[?format=&lt;json|toml&gt;]</cite><a class="headerlink" href="#api-v0-blueprints-info-blueprint-names-format-json-toml" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return the JSON representation of the blueprint. This includes 3 top level
objects.  <cite>changes</cite> which lists whether or not the workspace is different from
the most recent commit. <cite>blueprints</cite> which lists the JSON representation of the
blueprint, and <cite>errors</cite> which will list any errors, like non-existant blueprints.</p>
<p>By default the response is JSON, but if <cite>?format=toml</cite> is included in the URL’s
arguments it will return the response as the blueprint’s raw TOML content.
<em>Unless</em> there is an error which will only return a 400 and a standard error
<a href="#id1"><span class="problematic" id="id2">`Status Response`_</span></a>.</p>
<p>If there is an error when JSON is requested the successful blueprints and the
errors will both be returned.</p>
<p>Example of json response:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;changes&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;changed&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span>
    <span class="p">}</span>
  <span class="p">],</span>
  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;An example GlusterFS server with samba&quot;</span><span class="p">,</span>
      <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
        <span class="p">{</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.7.*&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs-cli&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.7.*&quot;</span>
        <span class="p">}</span>
      <span class="p">],</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
      <span class="s2">&quot;packages&quot;</span><span class="p">:</span> <span class="p">[</span>
        <span class="p">{</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;2ping&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.2.1&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;samba&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;4.2.*&quot;</span>
        <span class="p">}</span>
      <span class="p">],</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Error example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;changes&quot;</span><span class="p">:</span> <span class="p">[],</span>
  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;ggit-error: the path &#39;missing.toml&#39; does not exist in the given tree (-3)&quot;</span><span class="p">]</span>
  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-blueprints-changes-blueprint-names-offset-0-limit-20">
<h4><cite>/api/v0/blueprints/changes/&lt;blueprint_names&gt;[?offset=0&amp;limit=20]</cite><a class="headerlink" href="#api-v0-blueprints-changes-blueprint-names-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return the commits to a blueprint. By default it returns the first 20 commits, this
can be changed by passing <cite>offset</cite> and/or <cite>limit</cite>. The response will include the
commit hash, summary, timestamp, and optionally the revision number. The commit
hash can be passed to <cite>/api/v0/blueprints/diff/</cite> to retrieve the exact changes.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
  <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
  <span class="s2">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;changes&quot;</span><span class="p">:</span> <span class="p">[</span>
        <span class="p">{</span>
          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;e083921a7ed1cf2eec91ad12b9ad1e70ef3470be&quot;</span><span class="p">,</span>
          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.6 saved.&quot;</span><span class="p">,</span>
          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-23T00:18:13Z&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;cee5f4c20fc33ea4d54bfecf56f4ad41ad15f4f3&quot;</span><span class="p">,</span>
          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.5 saved.&quot;</span><span class="p">,</span>
          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-11T01:00:28Z&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;29b492f26ed35d80800b536623bafc51e2f0eff2&quot;</span><span class="p">,</span>
          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.4 saved.&quot;</span><span class="p">,</span>
          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-11T00:28:30Z&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;03374adbf080fe34f5c6c29f2e49cc2b86958bf2&quot;</span><span class="p">,</span>
          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.3 saved.&quot;</span><span class="p">,</span>
          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-10T23:15:52Z&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;0e08ecbb708675bfabc82952599a1712a843779d&quot;</span><span class="p">,</span>
          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.2 saved.&quot;</span><span class="p">,</span>
          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-10T23:14:56Z&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;3e11eb87a63d289662cba4b1804a0947a6843379&quot;</span><span class="p">,</span>
          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.1 saved.&quot;</span><span class="p">,</span>
          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-08T00:02:47Z&quot;</span>
        <span class="p">}</span>
      <span class="p">],</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
      <span class="s2">&quot;total&quot;</span><span class="p">:</span> <span class="mi">6</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="post-api-v0-blueprints-new">
<h4>POST <cite>/api/v0/blueprints/new</cite><a class="headerlink" href="#post-api-v0-blueprints-new" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Create a new blueprint, or update an existing blueprint. This supports both JSON and TOML
for the blueprint format. The blueprint should be in the body of the request with the
<cite>Content-Type</cite> header set to either <cite>application/json</cite> or <cite>text/x-toml</cite>.</p>
<p>The response will be a status response with <cite>status</cite> set to true, or an
error response with it set to false and an error message included.</p>
</div></blockquote>
</div>
<div class="section" id="delete-api-v0-blueprints-delete-blueprint-name">
<h4>DELETE <cite>/api/v0/blueprints/delete/&lt;blueprint_name&gt;</cite><a class="headerlink" href="#delete-api-v0-blueprints-delete-blueprint-name" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Delete a blueprint. The blueprint is deleted from the branch, and will no longer
be listed by the <cite>list</cite> route. A blueprint can be undeleted using the <cite>undo</cite> route
to revert to a previous commit. This will also delete the workspace copy of the
blueprint.</p>
<p>The response will be a status response with <cite>status</cite> set to true, or an
error response with it set to false and an error message included.</p>
</div></blockquote>
</div>
<div class="section" id="post-api-v0-blueprints-workspace">
<h4>POST <cite>/api/v0/blueprints/workspace</cite><a class="headerlink" href="#post-api-v0-blueprints-workspace" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Write a blueprint to the temporary workspace. This works exactly the same as <cite>new</cite> except
that it does not create a commit. JSON and TOML bodies are supported.</p>
<p>The workspace is meant to be used as a temporary blueprint storage for clients.
It will be read by the <cite>info</cite> and <cite>diff</cite> routes if it is different from the
most recent commit.</p>
<p>The response will be a status response with <cite>status</cite> set to true, or an
error response with it set to false and an error message included.</p>
</div></blockquote>
</div>
<div class="section" id="delete-api-v0-blueprints-workspace-blueprint-name">
<h4>DELETE <cite>/api/v0/blueprints/workspace/&lt;blueprint_name&gt;</cite><a class="headerlink" href="#delete-api-v0-blueprints-workspace-blueprint-name" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Remove the temporary workspace copy of a blueprint. The <cite>info</cite> route will now
return the most recent commit of the blueprint. Any changes that were in the
workspace will be lost.</p>
<p>The response will be a status response with <cite>status</cite> set to true, or an
error response with it set to false and an error message included.</p>
</div></blockquote>
</div>
<div class="section" id="post-api-v0-blueprints-undo-blueprint-name-commit">
<h4>POST <cite>/api/v0/blueprints/undo/&lt;blueprint_name&gt;/&lt;commit&gt;</cite><a class="headerlink" href="#post-api-v0-blueprints-undo-blueprint-name-commit" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>This will revert the blueprint to a previous commit. The commit hash from the <cite>changes</cite>
route can be used in this request.</p>
<p>The response will be a status response with <cite>status</cite> set to true, or an
error response with it set to false and an error message included.</p>
</div></blockquote>
</div>
<div class="section" id="post-api-v0-blueprints-tag-blueprint-name">
<h4>POST <cite>/api/v0/blueprints/tag/&lt;blueprint_name&gt;</cite><a class="headerlink" href="#post-api-v0-blueprints-tag-blueprint-name" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Tag a blueprint as a new release. This uses git tags with a special format.
<cite>refs/tags/&lt;branch&gt;/&lt;filename&gt;/r&lt;revision&gt;</cite>. Only the most recent blueprint commit
can be tagged. Revisions start at 1 and increment for each new tag
(per-blueprint). If the commit has already been tagged it will return false.</p>
<p>The response will be a status response with <cite>status</cite> set to true, or an
error response with it set to false and an error message included.</p>
</div></blockquote>
</div>
<div class="section" id="api-v0-blueprints-diff-blueprint-name-from-commit-to-commit">
<h4><cite>/api/v0/blueprints/diff/&lt;blueprint_name&gt;/&lt;from_commit&gt;/&lt;to_commit&gt;</cite><a class="headerlink" href="#api-v0-blueprints-diff-blueprint-name-from-commit-to-commit" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return the differences between two commits, or the workspace. The commit hash
from the <cite>changes</cite> response can be used here, or several special strings:</p>
<ul class="simple">
<li><p>NEWEST will select the newest git commit. This works for <cite>from_commit</cite> or <cite>to_commit</cite></p></li>
<li><p>WORKSPACE will select the workspace copy. This can only be used in <cite>to_commit</cite></p></li>
</ul>
<p>eg. <cite>/api/v0/blueprints/diff/glusterfs/NEWEST/WORKSPACE</cite> will return the differences
between the most recent git commit and the contents of the workspace.</p>
<p>Each entry in the response’s diff object contains the old blueprint value and the new one.
If old is null and new is set, then it was added.
If new is null and old is set, then it was removed.
If both are set, then it was changed.</p>
<p>The old/new entries will have the name of the blueprint field that was changed. This
can be one of: Name, Description, Version, Module, or Package.
The contents for these will be the old/new values for them.</p>
<p>In the example below the version was changed and the ping package was added.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;diff&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;new&quot;</span><span class="p">:</span> <span class="p">{</span>
        <span class="s2">&quot;Version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
      <span class="p">},</span>
      <span class="s2">&quot;old&quot;</span><span class="p">:</span> <span class="p">{</span>
        <span class="s2">&quot;Version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.5&quot;</span>
      <span class="p">}</span>
    <span class="p">},</span>
    <span class="p">{</span>
      <span class="s2">&quot;new&quot;</span><span class="p">:</span> <span class="p">{</span>
        <span class="s2">&quot;Package&quot;</span><span class="p">:</span> <span class="p">{</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;ping&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.2.1&quot;</span>
        <span class="p">}</span>
      <span class="p">},</span>
      <span class="s2">&quot;old&quot;</span><span class="p">:</span> <span class="n">null</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-blueprints-freeze-blueprint-names">
<h4><cite>/api/v0/blueprints/freeze/&lt;blueprint_names&gt;</cite><a class="headerlink" href="#api-v0-blueprints-freeze-blueprint-names" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return a JSON representation of the blueprint with the package and module versions set
to the exact versions chosen by depsolving the blueprint.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="p">{</span>
        <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;An example GlusterFS server with samba&quot;</span><span class="p">,</span>
        <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
          <span class="p">{</span>
            <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.8.4-18.4.el7.x86_64&quot;</span>
          <span class="p">},</span>
          <span class="p">{</span>
            <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs-cli&quot;</span><span class="p">,</span>
            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.8.4-18.4.el7.x86_64&quot;</span>
          <span class="p">}</span>
        <span class="p">],</span>
        <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
        <span class="s2">&quot;packages&quot;</span><span class="p">:</span> <span class="p">[</span>
          <span class="p">{</span>
            <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;ping&quot;</span><span class="p">,</span>
            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;2:3.2.1-2.el7.noarch&quot;</span>
          <span class="p">},</span>
          <span class="p">{</span>
            <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;samba&quot;</span><span class="p">,</span>
            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;4.6.2-8.el7.x86_64&quot;</span>
          <span class="p">}</span>
        <span class="p">],</span>
        <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
      <span class="p">}</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-blueprints-depsolve-blueprint-names">
<h4><cite>/api/v0/blueprints/depsolve/&lt;blueprint_names&gt;</cite><a class="headerlink" href="#api-v0-blueprints-depsolve-blueprint-names" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Depsolve the blueprint using yum, return the blueprint used, and the NEVRAs of the packages
chosen to satisfy the blueprint’s requirements. The response will include a list of results,
with the full dependency list in <cite>dependencies</cite>, the NEVRAs for the blueprint’s direct modules
and packages in <cite>modules</cite>, and any error will be in <cite>errors</cite>.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;dependencies&quot;</span><span class="p">:</span> <span class="p">[</span>
        <span class="p">{</span>
          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;noarch&quot;</span><span class="p">,</span>
          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;2ping&quot;</span><span class="p">,</span>
          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;2.el7&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.2.1&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;acl&quot;</span><span class="p">,</span>
          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;12.el7&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;2.2.51&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;audit-libs&quot;</span><span class="p">,</span>
          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;3.el7&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;2.7.6&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;avahi-libs&quot;</span><span class="p">,</span>
          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;17.el7&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.6.31&quot;</span>
        <span class="p">},</span>
        <span class="o">...</span>
      <span class="p">],</span>
      <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
        <span class="p">{</span>
          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;noarch&quot;</span><span class="p">,</span>
          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;2ping&quot;</span><span class="p">,</span>
          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;2.el7&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.2.1&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;18.4.el7&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.8.4&quot;</span>
        <span class="p">},</span>
        <span class="o">...</span>
      <span class="p">],</span>
      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="p">{</span>
        <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;An example GlusterFS server with samba&quot;</span><span class="p">,</span>
        <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
          <span class="p">{</span>
            <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.7.*&quot;</span>
          <span class="p">},</span>
       <span class="o">...</span>
      <span class="p">}</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-projects-list-offset-0-limit-20">
<h4><cite>/api/v0/projects/list[?offset=0&amp;limit=20]</cite><a class="headerlink" href="#api-v0-projects-list-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>List all of the available projects. By default this returns the first 20 items,
but this can be changed by setting the <cite>offset</cite> and <cite>limit</cite> arguments.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
  <span class="s2">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
  <span class="s2">&quot;projects&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;0 A.D. (pronounced &quot;</span><span class="n">zero</span> <span class="n">ey</span><span class="o">-</span><span class="n">dee</span><span class="s2">&quot;) is a ...&quot;</span><span class="p">,</span>
      <span class="s2">&quot;homepage&quot;</span><span class="p">:</span> <span class="s2">&quot;http://play0ad.com&quot;</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;0ad&quot;</span><span class="p">,</span>
      <span class="s2">&quot;summary&quot;</span><span class="p">:</span> <span class="s2">&quot;Cross-Platform RTS Game of Ancient Warfare&quot;</span><span class="p">,</span>
      <span class="s2">&quot;upstream_vcs&quot;</span><span class="p">:</span> <span class="s2">&quot;UPSTREAM_VCS&quot;</span>
    <span class="p">},</span>
    <span class="o">...</span>
  <span class="p">],</span>
  <span class="s2">&quot;total&quot;</span><span class="p">:</span> <span class="mi">21770</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-projects-info-project-names">
<h4><cite>/api/v0/projects/info/&lt;project_names&gt;</cite><a class="headerlink" href="#api-v0-projects-info-project-names" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return information about the comma-separated list of projects. It includes the description
of the package along with the list of available builds.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;projects&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;builds&quot;</span><span class="p">:</span> <span class="p">[</span>
        <span class="p">{</span>
          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
          <span class="s2">&quot;build_config_ref&quot;</span><span class="p">:</span> <span class="s2">&quot;BUILD_CONFIG_REF&quot;</span><span class="p">,</span>
          <span class="s2">&quot;build_env_ref&quot;</span><span class="p">:</span> <span class="s2">&quot;BUILD_ENV_REF&quot;</span><span class="p">,</span>
          <span class="s2">&quot;build_time&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-03-01T08:39:23&quot;</span><span class="p">,</span>
          <span class="s2">&quot;changelog&quot;</span><span class="p">:</span> <span class="s2">&quot;- restore incremental backups correctly, files ...&quot;</span><span class="p">,</span>
          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;2&quot;</span><span class="p">,</span>
          <span class="s2">&quot;metadata&quot;</span><span class="p">:</span> <span class="p">{},</span>
          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;32.el7&quot;</span><span class="p">,</span>
          <span class="s2">&quot;source&quot;</span><span class="p">:</span> <span class="p">{</span>
            <span class="s2">&quot;license&quot;</span><span class="p">:</span> <span class="s2">&quot;GPLv3+&quot;</span><span class="p">,</span>
            <span class="s2">&quot;metadata&quot;</span><span class="p">:</span> <span class="p">{},</span>
            <span class="s2">&quot;source_ref&quot;</span><span class="p">:</span> <span class="s2">&quot;SOURCE_REF&quot;</span><span class="p">,</span>
            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;1.26&quot;</span>
          <span class="p">}</span>
        <span class="p">}</span>
      <span class="p">],</span>
      <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;The GNU tar program saves many ...&quot;</span><span class="p">,</span>
      <span class="s2">&quot;homepage&quot;</span><span class="p">:</span> <span class="s2">&quot;http://www.gnu.org/software/tar/&quot;</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;tar&quot;</span><span class="p">,</span>
      <span class="s2">&quot;summary&quot;</span><span class="p">:</span> <span class="s2">&quot;A GNU file archiving program&quot;</span><span class="p">,</span>
      <span class="s2">&quot;upstream_vcs&quot;</span><span class="p">:</span> <span class="s2">&quot;UPSTREAM_VCS&quot;</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-projects-depsolve-project-names">
<h4><cite>/api/v0/projects/depsolve/&lt;project_names&gt;</cite><a class="headerlink" href="#api-v0-projects-depsolve-project-names" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Depsolve the comma-separated list of projects and return the list of NEVRAs needed
to satisfy the request.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;projects&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;noarch&quot;</span><span class="p">,</span>
      <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;basesystem&quot;</span><span class="p">,</span>
      <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;7.el7&quot;</span><span class="p">,</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;10.0&quot;</span>
    <span class="p">},</span>
    <span class="p">{</span>
      <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
      <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;bash&quot;</span><span class="p">,</span>
      <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;28.el7&quot;</span><span class="p">,</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;4.2.46&quot;</span>
    <span class="p">},</span>
    <span class="p">{</span>
      <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
      <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;filesystem&quot;</span><span class="p">,</span>
      <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;21.el7&quot;</span><span class="p">,</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.2&quot;</span>
    <span class="p">},</span>
    <span class="o">...</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-projects-source-list">
<h4><cite>/api/v0/projects/source/list</cite><a class="headerlink" href="#api-v0-projects-source-list" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return the list of repositories used for depsolving and installing packages.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;sources&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="s2">&quot;fedora&quot;</span><span class="p">,</span>
    <span class="s2">&quot;fedora-cisco-openh264&quot;</span><span class="p">,</span>
    <span class="s2">&quot;fedora-updates-testing&quot;</span><span class="p">,</span>
    <span class="s2">&quot;fedora-updates&quot;</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-projects-source-info-source-names">
<h4><cite>/api/v0/projects/source/info/&lt;source-names&gt;</cite><a class="headerlink" href="#api-v0-projects-source-info-source-names" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return information about the comma-separated list of source names. Or all of the
sources if ‘*’ is passed. Note that general globbing is not supported, only ‘*’.</p>
<p>immutable system sources will have the “system” field set to true. User added sources
will have it set to false. System sources cannot be changed or deleted.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
  <span class="s2">&quot;sources&quot;</span><span class="p">:</span> <span class="p">{</span>
    <span class="s2">&quot;fedora&quot;</span><span class="p">:</span> <span class="p">{</span>
      <span class="s2">&quot;check_gpg&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
      <span class="s2">&quot;check_ssl&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
      <span class="s2">&quot;gpgkey_urls&quot;</span><span class="p">:</span> <span class="p">[</span>
        <span class="s2">&quot;file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64&quot;</span>
      <span class="p">],</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;fedora&quot;</span><span class="p">,</span>
      <span class="s2">&quot;proxy&quot;</span><span class="p">:</span> <span class="s2">&quot;http://proxy.brianlane.com:8123&quot;</span><span class="p">,</span>
      <span class="s2">&quot;system&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
      <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;yum-metalink&quot;</span><span class="p">,</span>
      <span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="s2">&quot;https://mirrors.fedoraproject.org/metalink?repo=fedora-28&amp;arch=x86_64&quot;</span>
    <span class="p">}</span>
  <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="post-api-v0-projects-source-new">
<h4>POST <cite>/api/v0/projects/source/new</cite><a class="headerlink" href="#post-api-v0-projects-source-new" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Add (or change) a source for use when depsolving blueprints and composing images.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">proxy</span></code> and <code class="docutils literal notranslate"><span class="pre">gpgkey_urls</span></code> entries are optional. All of the others are required. The supported
types for the urls are:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">yum-baseurl</span></code> is a URL to a yum repository.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">yum-mirrorlist</span></code> is a URL for a mirrorlist.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">yum-metalink</span></code> is a URL for a metalink.</p></li>
</ul>
<p>If <code class="docutils literal notranslate"><span class="pre">check_ssl</span></code> is true the https certificates must be valid. If they are self-signed you can either set
this to false, or add your Certificate Authority to the host system.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">check_gpg</span></code> is true the GPG key must either be installed on the host system, or <code class="docutils literal notranslate"><span class="pre">gpgkey_urls</span></code>
should point to it.</p>
<p>You can edit an existing source (other than system sources), by doing a POST
of the new version of the source. It will overwrite the previous one.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
    <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;custom-source-1&quot;</span><span class="p">,</span>
    <span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="s2">&quot;https://url/path/to/repository/&quot;</span><span class="p">,</span>
    <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;yum-baseurl&quot;</span><span class="p">,</span>
    <span class="s2">&quot;check_ssl&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
    <span class="s2">&quot;check_gpg&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
    <span class="s2">&quot;gpgkey_urls&quot;</span><span class="p">:</span> <span class="p">[</span>
        <span class="s2">&quot;https://url/path/to/gpg-key&quot;</span>
    <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="delete-api-v0-projects-source-delete-source-name">
<h4>DELETE <cite>/api/v0/projects/source/delete/&lt;source-name&gt;</cite><a class="headerlink" href="#delete-api-v0-projects-source-delete-source-name" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Delete a user added source. This will fail if a system source is passed to
it.</p>
<p>The response will be a status response with <cite>status</cite> set to true, or an
error response with it set to false and an error message included.</p>
</div></blockquote>
</div>
<div class="section" id="api-v0-modules-list-offset-0-limit-20">
<h4><cite>/api/v0/modules/list[?offset=0&amp;limit=20]</cite><a class="headerlink" href="#api-v0-modules-list-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return a list of all of the available modules. This includes the name and the
group_type, which is always “rpm” for lorax-composer. By default this returns
the first 20 items. This can be changed by setting the <cite>offset</cite> and <cite>limit</cite>
arguments.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
  <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;group_type&quot;</span><span class="p">:</span> <span class="s2">&quot;rpm&quot;</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;0ad&quot;</span>
    <span class="p">},</span>
    <span class="p">{</span>
      <span class="s2">&quot;group_type&quot;</span><span class="p">:</span> <span class="s2">&quot;rpm&quot;</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;0ad-data&quot;</span>
    <span class="p">},</span>
    <span class="p">{</span>
      <span class="s2">&quot;group_type&quot;</span><span class="p">:</span> <span class="s2">&quot;rpm&quot;</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;0install&quot;</span>
    <span class="p">},</span>
    <span class="p">{</span>
      <span class="s2">&quot;group_type&quot;</span><span class="p">:</span> <span class="s2">&quot;rpm&quot;</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;2048-cli&quot;</span>
    <span class="p">},</span>
    <span class="o">...</span>
  <span class="p">]</span>
  <span class="s2">&quot;total&quot;</span><span class="p">:</span> <span class="mi">21770</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-modules-list-module-names-offset-0-limit-20">
<h4><cite>/api/v0/modules/list/&lt;module_names&gt;[?offset=0&amp;limit=20]</cite><a class="headerlink" href="#api-v0-modules-list-module-names-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return the list of comma-separated modules. Output is the same as <cite>/modules/list</cite></p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
  <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;group_type&quot;</span><span class="p">:</span> <span class="s2">&quot;rpm&quot;</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;tar&quot;</span>
    <span class="p">}</span>
  <span class="p">],</span>
  <span class="s2">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
  <span class="s2">&quot;total&quot;</span><span class="p">:</span> <span class="mi">1</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-modules-info-module-names">
<h4><cite>/api/v0/modules/info/&lt;module_names&gt;</cite><a class="headerlink" href="#api-v0-modules-info-module-names" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return the module’s dependencies, and the information about the module.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;dependencies&quot;</span><span class="p">:</span> <span class="p">[</span>
        <span class="p">{</span>
          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;noarch&quot;</span><span class="p">,</span>
          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;basesystem&quot;</span><span class="p">,</span>
          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;7.el7&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;10.0&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;bash&quot;</span><span class="p">,</span>
          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;28.el7&quot;</span><span class="p">,</span>
          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;4.2.46&quot;</span>
        <span class="p">},</span>
        <span class="o">...</span>
      <span class="p">],</span>
      <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;The GNU tar program saves ...&quot;</span><span class="p">,</span>
      <span class="s2">&quot;homepage&quot;</span><span class="p">:</span> <span class="s2">&quot;http://www.gnu.org/software/tar/&quot;</span><span class="p">,</span>
      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;tar&quot;</span><span class="p">,</span>
      <span class="s2">&quot;summary&quot;</span><span class="p">:</span> <span class="s2">&quot;A GNU file archiving program&quot;</span><span class="p">,</span>
      <span class="s2">&quot;upstream_vcs&quot;</span><span class="p">:</span> <span class="s2">&quot;UPSTREAM_VCS&quot;</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="post-api-v0-compose">
<h4>POST <cite>/api/v0/compose</cite><a class="headerlink" href="#post-api-v0-compose" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Start a compose. The content type should be ‘application/json’ and the body of the POST
should look like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;blueprint_name&quot;</span><span class="p">:</span> <span class="s2">&quot;http-server&quot;</span><span class="p">,</span>
  <span class="s2">&quot;compose_type&quot;</span><span class="p">:</span> <span class="s2">&quot;tar&quot;</span><span class="p">,</span>
  <span class="s2">&quot;branch&quot;</span><span class="p">:</span> <span class="s2">&quot;master&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Pass it the name of the blueprint, the type of output (from ‘/api/v0/compose/types’), and the
blueprint branch to use. ‘branch’ is optional and will default to master. It will create a new
build and add it to the queue. It returns the build uuid and a status if it succeeds:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;build_id&quot;</span><span class="p">:</span> <span class="s2">&quot;e6fa6db4-9c81-4b70-870f-a697ca405cdf&quot;</span><span class="p">,</span>
  <span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-compose-types">
<h4><cite>/api/v0/compose/types</cite><a class="headerlink" href="#api-v0-compose-types" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Returns the list of supported output types that are valid for use with ‘POST /api/v0/compose’</p>
<blockquote>
<div><dl>
<dt>{</dt><dd><dl>
<dt>“types”: [</dt><dd><dl class="simple">
<dt>{</dt><dd><p>“enabled”: true,
“name”: “tar”</p>
</dd>
</dl>
<p>}</p>
</dd>
</dl>
<p>]</p>
</dd>
</dl>
<p>}</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="api-v0-compose-queue">
<h4><cite>/api/v0/compose/queue</cite><a class="headerlink" href="#api-v0-compose-queue" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return the status of the build queue. It includes information about the builds waiting,
and the build that is running.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;new&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;45502a6d-06e8-48a5-a215-2b4174b3614b&quot;</span><span class="p">,</span>
      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;WAITING&quot;</span><span class="p">,</span>
      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517362647.4570868</span><span class="p">,</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
    <span class="p">},</span>
    <span class="p">{</span>
      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;6d292bd0-bec7-4825-8d7d-41ef9c3e4b73&quot;</span><span class="p">,</span>
      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;kubernetes&quot;</span><span class="p">,</span>
      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;WAITING&quot;</span><span class="p">,</span>
      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517362659.0034983</span><span class="p">,</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.1&quot;</span>
    <span class="p">}</span>
  <span class="p">],</span>
  <span class="s2">&quot;run&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;745712b2-96db-44c0-8014-fe925c35e795&quot;</span><span class="p">,</span>
      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;RUNNING&quot;</span><span class="p">,</span>
      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517362633.7965999</span><span class="p">,</span>
      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517362633.8001345</span><span class="p">,</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-compose-finished">
<h4><cite>/api/v0/compose/finished</cite><a class="headerlink" href="#api-v0-compose-finished" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return the details on all of the finished composes on the system.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;finished&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;70b84195-9817-4b8a-af92-45e380f39894&quot;</span><span class="p">,</span>
      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FINISHED&quot;</span><span class="p">,</span>
      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517351003.8210032</span><span class="p">,</span>
      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517351003.8230415</span><span class="p">,</span>
      <span class="s2">&quot;job_finished&quot;</span><span class="p">:</span> <span class="mf">1517359234.1003145</span><span class="p">,</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
    <span class="p">},</span>
    <span class="p">{</span>
      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;e695affd-397f-4af9-9022-add2636e7459&quot;</span><span class="p">,</span>
      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FINISHED&quot;</span><span class="p">,</span>
      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517362289.7193348</span><span class="p">,</span>
      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517362289.9751132</span><span class="p">,</span>
      <span class="s2">&quot;job_finished&quot;</span><span class="p">:</span> <span class="mf">1517363500.1234567</span><span class="p">,</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-compose-failed">
<h4><cite>/api/v0/compose/failed</cite><a class="headerlink" href="#api-v0-compose-failed" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return the details on all of the failed composes on the system.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;failed&quot;</span><span class="p">:</span> <span class="p">[</span>
     <span class="p">{</span>
      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;8c8435ef-d6bd-4c68-9bf1-a2ef832e6b1a&quot;</span><span class="p">,</span>
      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;http-server&quot;</span><span class="p">,</span>
      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FAILED&quot;</span><span class="p">,</span>
      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517523249.9301329</span><span class="p">,</span>
      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517523249.9314211</span><span class="p">,</span>
      <span class="s2">&quot;job_finished&quot;</span><span class="p">:</span> <span class="mf">1517523255.5623411</span><span class="p">,</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.2&quot;</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-compose-status-uuids-blueprint-blueprint-name-status-compose-status-type-compose-type">
<h4><cite>/api/v0/compose/status/&lt;uuids&gt;[?blueprint=&lt;blueprint_name&gt;&amp;status=&lt;compose_status&gt;&amp;type=&lt;compose_type&gt;]</cite><a class="headerlink" href="#api-v0-compose-status-uuids-blueprint-blueprint-name-status-compose-status-type-compose-type" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Return the details for each of the comma-separated list of uuids. A uuid of ‘*’ will return
details for all composes.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;uuids&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;8c8435ef-d6bd-4c68-9bf1-a2ef832e6b1a&quot;</span><span class="p">,</span>
      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;http-server&quot;</span><span class="p">,</span>
      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FINISHED&quot;</span><span class="p">,</span>
      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517523644.2384307</span><span class="p">,</span>
      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517523644.2551234</span><span class="p">,</span>
      <span class="s2">&quot;job_finished&quot;</span><span class="p">:</span> <span class="mf">1517523689.9864314</span><span class="p">,</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.2&quot;</span>
    <span class="p">},</span>
    <span class="p">{</span>
      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;45502a6d-06e8-48a5-a215-2b4174b3614b&quot;</span><span class="p">,</span>
      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FINISHED&quot;</span><span class="p">,</span>
      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517363442.188399</span><span class="p">,</span>
      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517363442.325324</span><span class="p">,</span>
      <span class="s2">&quot;job_finished&quot;</span><span class="p">:</span> <span class="mf">1517363451.653621</span><span class="p">,</span>
      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="delete-api-v0-compose-cancel-uuid">
<h4>DELETE <cite>/api/v0/compose/cancel/&lt;uuid&gt;</cite><a class="headerlink" href="#delete-api-v0-compose-cancel-uuid" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Cancel the build, if it is not finished, and delete the results. It will return a
status of True if it is successful.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
  <span class="s2">&quot;uuid&quot;</span><span class="p">:</span> <span class="s2">&quot;03397f8d-acff-4cdb-bd31-f629b7a948f5&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="delete-api-v0-compose-delete-uuids">
<h4>DELETE <cite>/api/v0/compose/delete/&lt;uuids&gt;</cite><a class="headerlink" href="#delete-api-v0-compose-delete-uuids" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Delete the list of comma-separated uuids from the compose results.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
  <span class="s2">&quot;uuids&quot;</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{</span>
      <span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
      <span class="s2">&quot;uuid&quot;</span><span class="p">:</span> <span class="s2">&quot;ae1bf7e3-7f16-4c9f-b36e-3726a1093fd0&quot;</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-compose-info-uuid">
<h4><cite>/api/v0/compose/info/&lt;uuid&gt;</cite><a class="headerlink" href="#api-v0-compose-info-uuid" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Get detailed information about the compose. The returned JSON string will
contain the following information:</p>
<blockquote>
<div><ul class="simple">
<li><p>id - The uuid of the comoposition</p></li>
<li><p>config - containing the configuration settings used to run Anaconda</p></li>
<li><p>blueprint - The depsolved blueprint used to generate the kickstart</p></li>
<li><p>commit - The (local) git commit hash for the blueprint used</p></li>
<li><p>deps - The NEVRA of all of the dependencies used in the composition</p></li>
<li><p>compose_type - The type of output generated (tar, iso, etc.)</p></li>
<li><p>queue_status - The final status of the composition (FINISHED or FAILED)</p></li>
</ul>
</div></blockquote>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;7078e521a54b12eae31c3fd028680da7a0815a4d&quot;</span><span class="p">,</span>
  <span class="s2">&quot;compose_type&quot;</span><span class="p">:</span> <span class="s2">&quot;tar&quot;</span><span class="p">,</span>
  <span class="s2">&quot;config&quot;</span><span class="p">:</span> <span class="p">{</span>
    <span class="s2">&quot;anaconda_args&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
    <span class="s2">&quot;armplatform&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
    <span class="s2">&quot;compress_args&quot;</span><span class="p">:</span> <span class="p">[],</span>
    <span class="s2">&quot;compression&quot;</span><span class="p">:</span> <span class="s2">&quot;xz&quot;</span><span class="p">,</span>
    <span class="s2">&quot;image_name&quot;</span><span class="p">:</span> <span class="s2">&quot;root.tar.xz&quot;</span><span class="p">,</span>
    <span class="o">...</span>
  <span class="p">},</span>
  <span class="s2">&quot;deps&quot;</span><span class="p">:</span> <span class="p">{</span>
    <span class="s2">&quot;packages&quot;</span><span class="p">:</span> <span class="p">[</span>
      <span class="p">{</span>
        <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
        <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
        <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;acl&quot;</span><span class="p">,</span>
        <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;14.el7&quot;</span><span class="p">,</span>
        <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;2.2.51&quot;</span>
      <span class="p">}</span>
    <span class="p">]</span>
  <span class="p">},</span>
  <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;c30b7d80-523b-4a23-ad52-61b799739ce8&quot;</span><span class="p">,</span>
  <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FINISHED&quot;</span><span class="p">,</span>
  <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="p">{</span>
    <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;An example kubernetes master&quot;</span><span class="p">,</span>
    <span class="o">...</span>
  <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="api-v0-compose-metadata-uuid">
<h4><cite>/api/v0/compose/metadata/&lt;uuid&gt;</cite><a class="headerlink" href="#api-v0-compose-metadata-uuid" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Returns a .tar of the metadata used for the build. This includes all the
information needed to reproduce the build, including the final kickstart
populated with repository and package NEVRA.</p>
<p>The mime type is set to ‘application/x-tar’ and the filename is set to
UUID-metadata.tar</p>
<p>The .tar is uncompressed, but is not large.</p>
</div></blockquote>
</div>
<div class="section" id="api-v0-compose-results-uuid">
<h4><cite>/api/v0/compose/results/&lt;uuid&gt;</cite><a class="headerlink" href="#api-v0-compose-results-uuid" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Returns a .tar of the metadata, logs, and output image of the build. This
includes all the information needed to reproduce the build, including the
final kickstart populated with repository and package NEVRA. The output image
is already in compressed form so the returned tar is not compressed.</p>
<p>The mime type is set to ‘application/x-tar’ and the filename is set to
UUID.tar</p>
</div></blockquote>
</div>
<div class="section" id="api-v0-compose-logs-uuid">
<h4><cite>/api/v0/compose/logs/&lt;uuid&gt;</cite><a class="headerlink" href="#api-v0-compose-logs-uuid" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Returns a .tar of the anaconda build logs. The tar is not compressed, but is
not large.</p>
<p>The mime type is set to ‘application/x-tar’ and the filename is set to
UUID-logs.tar</p>
</div></blockquote>
</div>
<div class="section" id="api-v0-compose-image-uuid">
<h4><cite>/api/v0/compose/image/&lt;uuid&gt;</cite><a class="headerlink" href="#api-v0-compose-image-uuid" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Returns the output image from the build. The filename is set to the filename
from the build with the UUID as a prefix. eg. UUID-root.tar.xz or UUID-boot.iso.</p>
</div></blockquote>
</div>
<div class="section" id="api-v0-compose-log-uuid-size-kbytes">
<h4><cite>/api/v0/compose/log/&lt;uuid&gt;[?size=kbytes]</cite><a class="headerlink" href="#api-v0-compose-log-uuid-size-kbytes" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><p>Returns the end of the anaconda.log. The size parameter is optional and defaults to 1Mbytes
if it is not included. The returned data is raw text from the end of the logfile, starting on
a line boundry.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">222</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">Thread</span><span class="p">:</span> <span class="n">AnaConfigurationThread</span> <span class="p">(</span><span class="mi">140629395244800</span><span class="p">)</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">223</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">installed</span> <span class="n">system</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">912</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">installed</span> <span class="n">system</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">912</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Creating</span> <span class="n">users</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">913</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Clearing</span> <span class="n">libuser</span><span class="o">.</span><span class="n">conf</span> <span class="n">at</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">libuser</span><span class="o">.</span><span class="n">Dyy8Gj</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">154</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Creating</span> <span class="n">users</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">155</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">addons</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">155</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">addons</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">155</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Generating</span> <span class="n">initramfs</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">49</span><span class="p">,</span><span class="mi">467</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Generating</span> <span class="n">initramfs</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">49</span><span class="p">,</span><span class="mi">467</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">post</span><span class="o">-</span><span class="n">installation</span> <span class="n">scripts</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">49</span><span class="p">,</span><span class="mi">467</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">kickstart</span> <span class="o">%%</span><span class="n">post</span> <span class="n">script</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">50</span><span class="p">,</span><span class="mi">782</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">All</span> <span class="n">kickstart</span> <span class="o">%%</span><span class="n">post</span> <span class="n">script</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="n">have</span> <span class="n">been</span> <span class="n">run</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">50</span><span class="p">,</span><span class="mi">782</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">post</span><span class="o">-</span><span class="n">installation</span> <span class="n">scripts</span>
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">50</span><span class="p">,</span><span class="mi">784</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Thread</span> <span class="n">Done</span><span class="p">:</span> <span class="n">AnaConfigurationThread</span> <span class="p">(</span><span class="mi">140629395244800</span><span class="p">)</span>
</pre></div>
</div>
</div></blockquote>
<dl class="py function">
<dt id="pylorax.api.v0.blueprint_exists">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.v0.</span></code><code class="sig-name descname"><span class="pre">blueprint_exists</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blueprint_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/v0.html#blueprint_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.v0.blueprint_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Return True if the blueprint exists</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>api</strong> (<em>Flask</em>) – flask object</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to read</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.v0.take_limits">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.v0.</span></code><code class="sig-name descname"><span class="pre">take_limits</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iterable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/v0.html#take_limits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.v0.take_limits" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply offset and limit to an iterable object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>iterable</strong> (<em>iter</em>) – The object to limit</p></li>
<li><p><strong>offset</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – The number of items to skip</p></li>
<li><p><strong>limit</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – The total number of items to return</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A subset of the iterable</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.v0.v0_api">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.v0.</span></code><code class="sig-name descname"><span class="pre">v0_api</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/v0.html#v0_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.v0.v0_api" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
</div>
</div>
<div class="section" id="module-pylorax.api.workspace">
<span id="pylorax-api-workspace-module"></span><h2>pylorax.api.workspace module<a class="headerlink" href="#module-pylorax.api.workspace" title="Permalink to this headline">¶</a></h2>
<dl class="py function">
<dt id="pylorax.api.workspace.workspace_delete">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.workspace.</span></code><code class="sig-name descname"><span class="pre">workspace_delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete the recipe from the workspace</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The name of the recipe</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>None</p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p>IO related errors</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.workspace.workspace_dir">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.workspace.</span></code><code class="sig-name descname"><span class="pre">workspace_dir</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_dir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>Create the workspace’s path from a Repository and branch</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The path to the branch’s workspace directory</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.workspace.workspace_read">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.workspace.</span></code><code class="sig-name descname"><span class="pre">workspace_read</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_read"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_read" title="Permalink to this definition">¶</a></dt>
<dd><p>Read a Recipe from the branch’s workspace</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The name of the recipe</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The workspace copy of the recipe, or None if it doesn’t exist</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>RecipeFileError</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pylorax.api.workspace.workspace_write">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.workspace.</span></code><code class="sig-name descname"><span class="pre">workspace_write</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_write"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_write" title="Permalink to this definition">¶</a></dt>
<dd><p>Write a recipe to the workspace</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
<li><p><strong>recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – The recipe to write to the workspace</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>None</p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p>IO related errors</p>
</dd>
</dl>
</dd></dl>

</div>
<div class="section" id="module-pylorax.api">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pylorax.api" title="Permalink to this headline">¶</a></h2>
<dl class="py function">
<dt id="pylorax.api.crossdomain">
<code class="sig-prename descclassname"><span class="pre">pylorax.api.</span></code><code class="sig-name descname"><span class="pre">crossdomain</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">origin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">methods</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_age</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">21600</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attach_to_all</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">automatic_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/crossdomain.html#crossdomain"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.crossdomain" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
</div>


           </div>
           
          </div>
          <footer>
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
        <a href="pylorax.html" class="btn btn-neutral float-left" title="pylorax package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; Copyright 2018-2019, Red Hat, Inc..

    </p>
  </div>
    
    
    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    
    provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
</body>
</html>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
 								<!DOCTYPE html>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<html class="writer-html5" lang="en" >
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<head>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								  <meta charset="utf-8" />
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								  <title>pylorax.api package &mdash; Lorax 28.14.58 documentation</title>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
 								  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								  <!--[if lt IE 9]>
 								    <script src="_static/js/html5shiv.min.js"></script>
 								  <![endif]-->
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
 								      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								        <script src="_static/jquery.js"></script>
 								        <script src="_static/underscore.js"></script>
 								        <script src="_static/doctools.js"></script>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
 								    <script type="text/javascript" src="_static/js/theme.js"></script>
 								    <link rel="index" title="Index" href="genindex.html" />
 								    <link rel="search" title="Search" href="search.html" />
 								    <link rel="prev" title="pylorax package" href="pylorax.html" />
 								</head>
 								<body class="wy-body-for-nav">
 								  <div class="wy-grid-for-nav">
 								    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
 								      <div class="wy-side-scroll">
 								        <div class="wy-side-nav-search" >
 								            <a href="index.html" class="icon icon-home"> Lorax
 								          </a>
 								              <div class="version">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+.14.58
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								              </div>
 								<div role="search">
 								  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
 								    <input type="text" name="q" placeholder="Search docs" />
 								    <input type="hidden" name="check_keywords" value="yes" />
 								    <input type="hidden" name="area" value="default" />
 								  </form>
 								</div>
 								        </div>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 								              <ul class="current">
 								<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction to Lorax</a></li>
 								<li class="toctree-l1"><a class="reference internal" href="intro.html#before-lorax">Before Lorax</a></li>
 								<li class="toctree-l1"><a class="reference internal" href="lorax.html">Lorax</a></li>
 								<li class="toctree-l1"><a class="reference internal" href="livemedia-creator.html">livemedia-creator</a></li>
 								<li class="toctree-l1"><a class="reference internal" href="lorax-composer.html">lorax-composer</a></li>
 								<li class="toctree-l1"><a class="reference internal" href="composer-cli.html">composer-cli</a></li>
 								<li class="toctree-l1"><a class="reference internal" href="product-images.html">Product and Updates Images</a></li>
 								<li class="toctree-l1 current"><a class="reference internal" href="modules.html">pylorax</a><ul class="current">
 								<li class="toctree-l2 current"><a class="reference internal" href="pylorax.html">pylorax package</a><ul class="current">
 								<li class="toctree-l3 current"><a class="reference internal" href="pylorax.html#subpackages">Subpackages</a><ul class="current">
 								<li class="toctree-l4 current"><a class="current reference internal" href="#">pylorax.api package</a></li>
 								</ul>
 								</li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#submodules">Submodules</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.base">pylorax.base module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.buildstamp">pylorax.buildstamp module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.cmdline">pylorax.cmdline module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.creator">pylorax.creator module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.decorators">pylorax.decorators module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.discinfo">pylorax.discinfo module</a></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.dnfbase">pylorax.dnfbase module</a></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.dnfhelper">pylorax.dnfhelper module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.executils">pylorax.executils module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.imgutils">pylorax.imgutils module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.installer">pylorax.installer module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.ltmpl">pylorax.ltmpl module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.monitor">pylorax.monitor module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.mount">pylorax.mount module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.output">pylorax.output module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.sysutils">pylorax.sysutils module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.treebuilder">pylorax.treebuilder module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.treeinfo">pylorax.treeinfo module</a></li>
 								<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax">Module contents</a></li>
 								</ul>
 								</li>
 								</ul>
 								</li>
 								</ul>
 								        </div>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								      </div>
 								    </nav>
 								    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 								      <nav class="wy-nav-top" aria-label="top navigation">
 								          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 								          <a href="index.html">Lorax</a>
 								      </nav>
 								      <div class="wy-nav-content">
 								        <div class="rst-content">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<div role="navigation" aria-label="breadcrumbs navigation">
 								  <ul class="wy-breadcrumbs">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
 								          <li><a href="modules.html">pylorax</a> &raquo;</li>
 								          <li><a href="pylorax.html">pylorax package</a> &raquo;</li>
 								      <li>pylorax.api package</li>
 								      <li class="wy-breadcrumbs-aside">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								            <a href="_sources/pylorax.api.rst.txt" rel="nofollow"> View page source</a>
 								      </li>
 								  </ul>
 								  <hr/>
 								</div>
 								          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 								           <div itemprop="articleBody">
 								  <div class="section" id="pylorax-api-package">
 								<h1>pylorax.api package<a class="headerlink" href="#pylorax-api-package" title="Permalink to this headline">¶</a></h1>
 								<div class="section" id="submodules">
 								<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
 								</div>
 								<div class="section" id="module-pylorax.api.cmdline">
 								<span id="pylorax-api-cmdline-module"></span><h2>pylorax.api.cmdline module<a class="headerlink" href="#module-pylorax.api.cmdline" title="Permalink to this headline">¶</a></h2>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.cmdline.lorax_composer_parser">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.cmdline.</span></code><code class="sig-name descname"><span class="pre">lorax_composer_parser</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/cmdline.html#lorax_composer_parser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.cmdline.lorax_composer_parser" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the ArgumentParser for lorax-composer</p>
 								</dd></dl>
 								</div>
 								<div class="section" id="module-pylorax.api.compose">
 								<span id="pylorax-api-compose-module"></span><h2>pylorax.api.compose module<a class="headerlink" href="#module-pylorax.api.compose" title="Permalink to this headline">¶</a></h2>
 								<p>Setup for composing an image</p>
 								<div class="section" id="adding-new-output-types">
 								<h3>Adding New Output Types<a class="headerlink" href="#adding-new-output-types" title="Permalink to this headline">¶</a></h3>
 								<p>The new output type must add a kickstart template to ./share/composer/ where the
 								name of the kickstart (without the trailing .ks) matches the entry in compose_args.</p>
 								<p>The kickstart should not have any url or repo entries, these will be added at build
 								time. The %packages section should be the last thing, and while it can contain mandatory
 								packages required by the output type, it should not have the trailing %end because the
 								package NEVRAs will be appended to it at build time.</p>
 								<p>compose_args should have a name matching the kickstart, and it should set the novirt_install
 								parameters needed to generate the desired output. Other types should be set to False.</p>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.add_customizations">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">add_customizations</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#add_customizations"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.add_customizations" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Add customizations to the kickstart file</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>f</strong> (<em>open file object</em>) – kickstart file object</p></li>
 								<li><p><strong>recipe</strong> (<em>Recipe object</em>) – </p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>None</p>
 								</dd>
 								<dt class="field-odd">Raises</dt>
 								<dd class="field-odd"><p>RuntimeError if there was a problem writing to the kickstart</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.bootloader_append">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">bootloader_append</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kernel_append</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#bootloader_append"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.bootloader_append" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Insert the kernel_append string into the –append argument</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The bootloader … line</p></li>
 								<li><p><strong>kernel_append</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The arguments to append to the –append section</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Using pykickstart to process the line is the best way to make sure it
 								is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.compose_args">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">compose_args</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compose_type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#compose_args"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.compose_args" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Returns the settings to pass to novirt_install for the compose type</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>compose_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The type of compose to create, from <cite>compose_types()</cite></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>This will return a dict of options that match the ArgumentParser options for livemedia-creator.
 								These are the ones the define the type of output, it’s filename, etc.
 								Other options will be filled in by <cite>make_compose()</cite></p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.compose_types">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">compose_types</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">share_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#compose_types"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.compose_types" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Returns a list of tuples of the supported output types, and their state</p>
 								<p>The output types come from the kickstart names in /usr/share/lorax/composer/*ks</p>
 								<p>If they are disabled on the current arch their state is False. If enabled, it is True.
 								eg. [(“alibaba”, False), (“ext4-filesystem”, True), …]</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.customize_ks_template">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">customize_ks_template</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ks_template</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#customize_ks_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.customize_ks_template" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Customize the kickstart template and return it</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>ks_template</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The kickstart template</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p><strong>recipe</strong> (<em>Recipe object</em>) – </p></li>
 								</ul>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Apply customizations to existing template commands, or add defaults for ones that are
 								missing and required.</p>
 								<p>Apply customizations.kernel.append to the bootloader argument in the template.
 								Add bootloader line if it is missing.</p>
 								<p>Add default timezone if needed. It does NOT replace an existing timezone entry</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.firewall_cmd">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">firewall_cmd</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#firewall_cmd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.firewall_cmd" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Update the firewall line with the new ports and services</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The firewall … line</p></li>
 								<li><p><strong>settings</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A dict with the list of services and ports to enable and disable</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Using pykickstart to process the line is the best way to make sure it
 								is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.get_default_services">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_default_services</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_default_services"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_default_services" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Get the default string for services, based on recipe
 								:param recipe: The recipe</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Returns</dt>
 								<dd class="field-odd"><p>string with “services” or “”</p>
 								</dd>
 								<dt class="field-even">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>When no services have been selected we don’t need to add anything to the kickstart
 								so return an empty string. Otherwise return “services” which will be updated with
 								the settings.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.get_extra_pkgs">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_extra_pkgs</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">share_dir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compose_type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_extra_pkgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_extra_pkgs" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return extra packages needed for the output type</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>share_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Path to the top level share directory</p></li>
 								<li><p><strong>compose_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The type of output to create from the recipe</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>List of package names (name only, not NEVRA)</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Currently this is only needed by live-iso, it reads ./live/live-install.tmpl and
 								processes only the installpkg lines. It lists the packages needed to complete creation of the
 								iso using the templates such as x86.tmpl</p>
 								<p>Keep in mind that the live-install.tmpl is shared between livemedia-creator and lorax-composer,
 								even though the results are applied differently.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.get_firewall_settings">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_firewall_settings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_firewall_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_firewall_settings" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the customizations.firewall settings</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – The recipe</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A dict of settings</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.get_kernel_append">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_kernel_append</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_kernel_append"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_kernel_append" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the customizations.kernel append value</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – </p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>append value or empty string</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.get_keyboard_layout">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_keyboard_layout</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_keyboard_layout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_keyboard_layout" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the customizations.locale.keyboard list</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – The recipe</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The keyboard layout string</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.get_languages">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_languages</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_languages"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_languages" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the customizations.locale.languages list</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – The recipe</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>list of language strings</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.get_services">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_services</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_services"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_services" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the customizations.services settings</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – The recipe</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A dict of settings</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.get_timezone_settings">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">get_timezone_settings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#get_timezone_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.get_timezone_settings" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the customizations.timezone dict</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) – </p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>append value or empty string</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.keyboard_cmd">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">keyboard_cmd</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#keyboard_cmd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.keyboard_cmd" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Update the keyboard line with the layout</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The keyboard … line</p></li>
 								<li><p><strong>settings</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The keyboard layout</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Using pykickstart to process the line is the best way to make sure it
 								is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.lang_cmd">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">lang_cmd</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">languages</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#lang_cmd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.lang_cmd" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Update the lang line with the languages</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The lang … line</p></li>
 								<li><p><strong>settings</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)"><em>list</em></a>) – The list of languages</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Using pykickstart to process the line is the best way to make sure it
 								is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.move_compose_results">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">move_compose_results</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">results_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#move_compose_results"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.move_compose_results" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Move the final image to the results_dir and cleanup the unneeded compose files</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><em>DataHolder</em></a>) – Build configuration</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>results_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Directory to put the results into</p></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</ul>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.repo_to_ks">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">repo_to_ks</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">r</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'url'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#repo_to_ks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.repo_to_ks" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a kickstart line with the correct args.
 								:param r: DNF repository information
 								:type r: dnf.Repo
 								:param url: “url” or “baseurl” to use for the baseurl parameter
 								:type url: str
 								:returns: kickstart command arguments for url/repo command
 								:rtype: str</p>
 								<p>Set url to “baseurl” if it is a repo, leave it as “url” for the installation url.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.services_cmd">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">services_cmd</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#services_cmd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.services_cmd" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Update the services line with additional services to enable/disable</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The services … line</p></li>
 								<li><p><strong>settings</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A dict with the list of services to enable and disable</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Using pykickstart to process the line is the best way to make sure it
 								is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.start_build">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">start_build</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dnflock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gitlock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compose_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#start_build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.start_build" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Start the build</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration object</p></li>
 								<li><p><strong>dnflock</strong> (<em>YumLock</em>) – Lock and YumBase for depsolving</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>recipe</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The recipe to build</p></li>
 								<li><p><strong>compose_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The type of output to create from the recipe</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>Unique ID for the build that can be used to track its status</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.test_templates">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">test_templates</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">share_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#test_templates"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.test_templates" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Try depsolving each of the the templates and report any errors</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>List of template types and errors</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>List of errors</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Return a list of templates and errors encountered or an empty list</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.timezone_cmd">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">timezone_cmd</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#timezone_cmd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.timezone_cmd" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Update the timezone line with the settings</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The timezone … line</p></li>
 								<li><p><strong>settings</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A dict with timezone and/or ntpservers list</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Using pykickstart to process the line is the best way to make sure it
 								is parsed correctly, and re-assembled for inclusion into the final kickstart</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.write_ks_group">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">write_ks_group</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#write_ks_group"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.write_ks_group" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Write kickstart group entry</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>f</strong> (<em>open file object</em>) – kickstart file object</p></li>
 								<li><p><strong>group</strong> – A blueprint group dictionary</p></li>
 								</ul>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>gid is optional</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.write_ks_root">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">write_ks_root</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#write_ks_root"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.write_ks_root" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Write kickstart root password and sshkey entry</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>f</strong> (<em>open file object</em>) – kickstart file object</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>user</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A blueprint user dictionary</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>True if it wrote a rootpw command to the kickstart</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>If the entry contains a ssh key, use sshkey to write it
 								If it contains password, use rootpw to set it</p>
 								<p>root cannot be used with the user command. So only key and password are supported
 								for root.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.compose.write_ks_user">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.compose.</span></code><code class="sig-name descname"><span class="pre">write_ks_user</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#write_ks_user"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.compose.write_ks_user" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Write kickstart user and sshkey entry</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>f</strong> (<em>open file object</em>) – kickstart file object</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>user</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A blueprint user dictionary</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>If the entry contains a ssh key, use sshkey to write it
 								All of the user fields are optional, except name, write out a kickstart user entry
 								with whatever options are relevant.</p>
 								</dd></dl>
 								</div>
 								</div>
 								<div class="section" id="module-pylorax.api.config">
 								<span id="pylorax-api-config-module"></span><h2>pylorax.api.config module<a class="headerlink" href="#module-pylorax.api.config" title="Permalink to this headline">¶</a></h2>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py class">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.config.ComposerConfig">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.config.</span></code><code class="sig-name descname"><span class="pre">ComposerConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#ComposerConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.config.ComposerConfig" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">configparser.SafeConfigParser</span></code></p>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.config.ComposerConfig.get_default">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-name descname"><span class="pre">get_default</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#ComposerConfig.get_default"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.config.ComposerConfig.get_default" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd></dd></dl>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.config.configure">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.config.</span></code><code class="sig-name descname"><span class="pre">configure</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/etc/lorax/composer.conf'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#configure"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.config.configure" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>lorax-composer configuration</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>conf_file</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Path to the config file overriding the default settings</p></li>
 								<li><p><strong>root_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Directory to prepend to paths, defaults to /</p></li>
 								<li><p><strong>test_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – Set to True to skip reading conf_file</p></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</ul>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.config.make_dnf_dirs">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.config.</span></code><code class="sig-name descname"><span class="pre">make_dnf_dirs</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#make_dnf_dirs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.config.make_dnf_dirs" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Make any missing dnf directories</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>conf</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – The configuration to use</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>None</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.config.make_queue_dirs">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.config.</span></code><code class="sig-name descname"><span class="pre">make_queue_dirs</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#make_queue_dirs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.config.make_queue_dirs" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Make any missing queue directories</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>conf</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – The configuration to use</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>gid</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Group ID that has access to the queue directories</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>list of errors</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>list of str</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
 								</div>
 								<div class="section" id="module-pylorax.api.crossdomain">
 								<span id="pylorax-api-crossdomain-module"></span><h2>pylorax.api.crossdomain module<a class="headerlink" href="#module-pylorax.api.crossdomain" title="Permalink to this headline">¶</a></h2>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.crossdomain.crossdomain">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.crossdomain.</span></code><code class="sig-name descname"><span class="pre">crossdomain</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">origin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">methods</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_age</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">21600</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attach_to_all</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">automatic_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/crossdomain.html#crossdomain"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.crossdomain.crossdomain" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd></dd></dl>
 								</div>
 								<div class="section" id="pylorax-api-dnfbase-module">
 								<h2>pylorax.api.dnfbase module<a class="headerlink" href="#pylorax-api-dnfbase-module" title="Permalink to this headline">¶</a></h2>
 								</div>
 								<div class="section" id="module-pylorax.api.projects">
 								<span id="pylorax-api-projects-module"></span><h2>pylorax.api.projects module<a class="headerlink" href="#module-pylorax.api.projects" title="Permalink to this headline">¶</a></h2>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py exception">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.ProjectsError">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">ProjectsError</span></code><a class="reference internal" href="_modules/pylorax/api/projects.html#ProjectsError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.ProjectsError" title="Permalink to this definition">¶</a></dt>
 								<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.api_changelog">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">api_changelog</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">changelog</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#api_changelog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.api_changelog" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Convert the changelog to a string</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>changelog</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)"><em>tuple</em></a>) – A list of time, author, string tuples.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The most recent changelog text or “”</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>This returns only the most recent changelog entry.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.api_time">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">api_time</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#api_time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.api_time" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Convert time since epoch to a string</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>t</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Seconds since epoch</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>Time string</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.delete_repo_source">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">delete_repo_source</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_glob</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#delete_repo_source"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.delete_repo_source" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Delete a source from a repo file</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>source_glob</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – A glob of the repo sources to search</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>None</p>
 								</dd>
 								<dt class="field-odd">Raises</dt>
 								<dd class="field-odd"><p>ProjectsError if there was a problem</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>A repo file may have multiple sources in it, delete only the selected source.
 								If it is the last one in the file, delete the file.</p>
 								<p>WARNING: This will delete ANY source, the caller needs to ensure that a system
 								source_name isn’t passed to it.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.dep_evra">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">dep_evra</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dep</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#dep_evra"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.dep_evra" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the epoch:version-release.arch for the dep</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>dep</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – dependency dict</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>epoch:version-release.arch</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.dep_nevra">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">dep_nevra</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dep</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#dep_nevra"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.dep_nevra" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the name-epoch:version-release.arch</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.dnf_repo_to_file_repo">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">dnf_repo_to_file_repo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#dnf_repo_to_file_repo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.dnf_repo_to_file_repo" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a string representation of a DNF Repo object suitable for writing to a .repo file</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>repo</strong> (<em>dnf.RepoDict</em>) – DNF Repository</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A string</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>The DNF Repo.dump() function does not produce a string that can be used as a dnf .repo file,
 								it ouputs baseurl and gpgkey as python lists which DNF cannot read. So do this manually with
 								only the attributes we care about.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.estimate_size">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">estimate_size</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">packages</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">block_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">6144</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#estimate_size"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.estimate_size" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Estimate the installed size of a package list</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>packages</strong> (<em>list of hawkey.Package objects</em>) – The packages to be installed</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>block_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – The block size to use for rounding up file sizes.</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The estimated size of installed packages</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)">int</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Estimating actual requirements is difficult without the actual file sizes, which
 								dnf doesn’t provide access to. So use the file count and block size to estimate
 								a minimum size for each package.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.get_repo_sources">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">get_repo_sources</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_glob</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#get_repo_sources"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.get_repo_sources" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a list of sources from a directory of yum repositories</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>source_glob</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – A glob to use to match the source files, including full path</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A list of the source ids in all of the matching files</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>list of str</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.get_source_ids">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">get_source_ids</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#get_source_ids"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.get_source_ids" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a list of the source ids in a file</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>source_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Full path and filename of the source (yum repo) file</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A list of source id strings</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>list of str</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.modules_info">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">modules_info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module_names</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#modules_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.modules_info" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return details about a module, including dependencies</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>module_names</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Names of the modules to get info about</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>List of dicts with module details and dependencies.</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>list of dicts</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.modules_list">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">modules_list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module_names</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#modules_list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.modules_list" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a list of modules</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
 								<li><p><strong>offset</strong> – Number of modules to skip</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>limit</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Maximum number of modules to return</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>List of module information and total count</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>tuple of a list of dicts and an Int</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Modules don’t exist in RHEL7 so this only returns projects
 								and sets the type to “rpm”</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.pkg_to_build">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">pkg_to_build</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#pkg_to_build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.pkg_to_build" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Extract the build details from a hawkey.Package object</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>pkg</strong> (<em>hawkey.Package</em>) – hawkey.Package object with package details</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A dict with the build details, epoch, release, arch, build_time, changelog, …</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>metadata entries are hard-coded to {}</p>
 								<p>Note that this only returns the build dict, it does not include the name, description, etc.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.pkg_to_dep">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">pkg_to_dep</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#pkg_to_dep"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.pkg_to_dep" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Extract the info from a hawkey.Package object</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>pkg</strong> (<em>hawkey.Package</em>) – A hawkey.Package object</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A dict with name, epoch, version, release, arch</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.pkg_to_project">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">pkg_to_project</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#pkg_to_project"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.pkg_to_project" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Extract the details from a hawkey.Package object</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>pkgs</strong> (<em>hawkey.Package</em>) – hawkey.Package object with package details</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A dict with the name, summary, description, and url.</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>upstream_vcs is hard-coded to UPSTREAM_VCS</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.pkg_to_project_info">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">pkg_to_project_info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pkg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#pkg_to_project_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.pkg_to_project_info" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Extract the details from a hawkey.Package object</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>pkg</strong> (<em>hawkey.Package</em>) – hawkey.Package object with package details</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A dict with the project details, as well as epoch, release, arch, build_time, changelog, …</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>metadata entries are hard-coded to {}</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.proj_to_module">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">proj_to_module</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#proj_to_module"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.proj_to_module" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Extract the name from a project_info dict</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>pkg</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – dict with package details</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A dict with name, and group_type</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>group_type is hard-coded to “rpm”</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.projects_depsolve">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">projects_depsolve</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">projects</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_depsolve"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.projects_depsolve" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the dependencies for a list of projects</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
 								<li><p><strong>projects</strong> (<em>List of Strings</em>) – The projects to find the dependencies for</p></li>
 								<li><p><strong>groups</strong> (<em>List of str</em>) – The groups to include in dependency solving</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>NEVRA’s of the project and its dependencies</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>list of dicts</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>ProjectsError if there was a problem installing something</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.projects_depsolve_with_size">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">projects_depsolve_with_size</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">projects</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_core</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_depsolve_with_size"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.projects_depsolve_with_size" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the dependencies and installed size for a list of projects</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
 								<li><p><strong>project_names</strong> (<em>List of Strings</em>) – The projects to find the dependencies for</p></li>
 								<li><p><strong>groups</strong> (<em>List of str</em>) – The groups to include in dependency solving</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>installed size and a list of NEVRA’s of the project and its dependencies</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p>tuple of (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)">int</a>, list of dicts)</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>ProjectsError if there was a problem installing something</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.projects_info">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">projects_info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_names</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.projects_info" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return details about specific projects</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>project_names</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – List of names of projects to get info about</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>List of project info dicts with pkg_to_project as well as epoch, version, release, etc.</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>list of dicts</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>If project_names is None it will return the full list of available packages</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.projects_list">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">projects_list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbo</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.projects_list" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a list of projects</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>List of project info dicts with name, summary, description, homepage, upstream_vcs</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>list of dicts</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.repo_to_source">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">repo_to_source</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">system_source</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#repo_to_source"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.repo_to_source" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a Weldr Source dict created from the DNF Repository</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>dnf.RepoDict</em>) – DNF Repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>system_source</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – True if this source is an immutable system source</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A dict with Weldr Source fields filled in</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;check_gpg&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
 								  <span class="s2">&quot;check_ssl&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
 								  <span class="s2">&quot;gpgkey_url&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="s2">&quot;file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64&quot;</span>
 								  <span class="p">],</span>
 								  <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;fedora&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;proxy&quot;</span><span class="p">:</span> <span class="s2">&quot;http://proxy.brianlane.com:8123&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;system&quot;</span><span class="p">:</span> <span class="n">true</span>
 								  <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;yum-metalink&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="s2">&quot;https://mirrors.fedoraproject.org/metalink?repo=fedora-28&amp;arch=x86_64&quot;</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.projects.source_to_repo">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.projects.</span></code><code class="sig-name descname"><span class="pre">source_to_repo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dnf_conf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#source_to_repo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.projects.source_to_repo" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a dnf Repo object created from a source dict</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>source</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A Weldr source dict</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A dnf Repo object</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>dnf.Repo</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;check_gpg&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 								  <span class="s2">&quot;check_ssl&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 								  <span class="s2">&quot;gpgkey_urls&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="s2">&quot;file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64&quot;</span>
 								  <span class="p">],</span>
 								  <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;fedora&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;proxy&quot;</span><span class="p">:</span> <span class="s2">&quot;http://proxy.brianlane.com:8123&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;system&quot;</span><span class="p">:</span> <span class="kc">True</span>
 								  <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;yum-metalink&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="s2">&quot;https://mirrors.fedoraproject.org/metalink?repo=fedora-28&amp;arch=x86_64&quot;</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</dd></dl>
 								</div>
 								<div class="section" id="module-pylorax.api.queue">
 								<span id="pylorax-api-queue-module"></span><h2>pylorax.api.queue module<a class="headerlink" href="#module-pylorax.api.queue" title="Permalink to this headline">¶</a></h2>
 								<p>Functions to monitor compose queue and run anaconda</p>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.build_status">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">build_status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status_filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#build_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.build_status" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the details of finished or failed builds</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>status_filter</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – What builds to return. None == all, “FINISHED”, or “FAILED”</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A list of the build details (from compose_details)</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>list of dicts</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>This returns a list of build details for each of the matching builds on the
 								system. It does not return the status of builds that have not been finished.
 								Use queue_status() for those.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.check_queues">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">check_queues</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#check_queues"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.check_queues" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Check to make sure the new and run queue symlinks are correct</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>cfg</strong> (<a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><em>DataHolder</em></a>) – Configuration settings</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Also check all of the existing results and make sure any with WAITING
 								set in STATUS have a symlink in queue/new/</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.compose_detail">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">compose_detail</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">results_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#compose_detail"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.compose_detail" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return details about the build.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>results_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The directory containing the metadata and results for the build</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A dictionary with details about the compose</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>IOError if it cannot read the directory, STATUS, or blueprint file.</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>The following details are included in the dict:</p>
 								<ul class="simple">
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p>id - The uuid of the comoposition</p></li>
 								<li><p>queue_status - The final status of the composition (FINISHED or FAILED)</p></li>
 								<li><p>compose_type - The type of output generated (tar, iso, etc.)</p></li>
 								<li><p>blueprint - Blueprint name</p></li>
 								<li><p>version - Blueprint version</p></li>
 								<li><p>image_size - Size of the image, if finished. 0 otherwise.</p></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</ul>
 								<p>Various timestamps are also included in the dict.  These are all Unix UTC timestamps.
 								It is possible for these timestamps to not always exist, in which case they will be
 								None in Python (or null in JSON).  The following timestamps are included:</p>
 								<ul class="simple">
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p>job_created - When the user submitted the compose</p></li>
 								<li><p>job_started - Anaconda started running</p></li>
 								<li><p>job_finished - Job entered FINISHED or FAILED state</p></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</ul>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.get_compose_type">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">get_compose_type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">results_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#get_compose_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.get_compose_type" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the type of composition.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>results_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The directory containing the metadata and results for the build</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The type of compose (eg. ‘tar’)</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>RuntimeError if no kickstart template can be found.</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.get_image_name">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">get_image_name</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#get_image_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.get_image_name" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the filename and full path of the build’s image file</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The image filename and full path</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>tuple of strings</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>RuntimeError if there was a problem (eg. invalid uuid, missing config file)</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.make_compose">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">make_compose</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">results_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#make_compose"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.make_compose" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Run anaconda with the final-kickstart.ks from results_dir</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><em>DataHolder</em></a>) – Configuration settings</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>results_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The directory containing the metadata and results for the build</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>Nothing</p>
 								</dd>
 								<dt class="field-odd">Raises</dt>
 								<dd class="field-odd"><p>May raise various exceptions</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>This takes the final-kickstart.ks, and the settings in config.toml and runs Anaconda
 								in no-virt mode (directly on the host operating system). Exceptions should be caught
 								at the higer level.</p>
 								<p>If there is a failure, the build artifacts will be cleaned up, and any logs will be
 								moved into logs/anaconda/ and their ownership will be set to the user from the cfg
 								object.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.monitor">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">monitor</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#monitor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.monitor" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Monitor the queue for new compose requests</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>cfg</strong> (<a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><em>DataHolder</em></a>) – Configuration settings</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>Does not return</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>The queue has 2 subdirectories, new and run. When a compose is ready to be run
 								a symlink to the uniquely named results directory should be placed in ./queue/new/</p>
 								<p>When the it is ready to be run (it is checked every 30 seconds or after a previous
 								compose is finished) the symlink will be moved into ./queue/run/ and a STATUS file
 								will be created in the results directory.</p>
 								<p>STATUS can contain one of: WAITING, RUNNING, FINISHED, FAILED</p>
 								<p>If the system is restarted while a compose is running it will move any old symlinks
 								from ./queue/run/ to ./queue/new/ and rerun them.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.queue_status">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">queue_status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#queue_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.queue_status" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return details about what is in the queue.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A list of the new composes, and a list of the running composes</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>This returns a dict with 2 lists. “new” is the list of uuids that are waiting to be built,
 								and “run” has the uuids that are being built (currently limited to 1 at a time).</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.start_queue_monitor">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">start_queue_monitor</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#start_queue_monitor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.start_queue_monitor" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Start the queue monitor as a mp process</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>uid</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – User ID that owns the queue</p></li>
 								<li><p><strong>gid</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Group ID that owns the queue</p></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</ul>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>None</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.uuid_cancel">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_cancel</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_cancel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_cancel" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Cancel a build and delete its results</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>True if it was canceled and deleted</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Only call this if the build status is WAITING or RUNNING</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.uuid_delete">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_delete" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Delete all of the results from a compose</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>True if it was deleted</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>This will raise an error if the delete failed</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.uuid_image">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_image</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_image" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the filename and full path of the build’s image file</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The image filename and full path</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>tuple of strings</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>RuntimeError if there was a problem (eg. invalid uuid, missing config file)</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.uuid_info">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_info" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return information about the composition</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>dictionary of information about the composition or None</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>RuntimeError if there was a problem</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>This will return a dict with the following fields populated:</p>
 								<ul class="simple">
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p>id - The uuid of the comoposition</p></li>
 								<li><p>config - containing the configuration settings used to run Anaconda</p></li>
 								<li><p>blueprint - The depsolved blueprint used to generate the kickstart</p></li>
 								<li><p>commit - The (local) git commit hash for the blueprint used</p></li>
 								<li><p>deps - The NEVRA of all of the dependencies used in the composition</p></li>
 								<li><p>compose_type - The type of output generated (tar, iso, etc.)</p></li>
 								<li><p>queue_status - The final status of the composition (FINISHED or FAILED)</p></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</ul>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.uuid_log">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_log</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1024</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_log"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_log" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return <cite>size</cite> kbytes from the end of the anaconda.log</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
 								<li><p><strong>size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Number of kbytes to read. Default is 1024</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>Up to <cite>size</cite> kbytes from the end of the log</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>RuntimeError if there was a problem (eg. no log file available)</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>This function tries to return lines from the end of the log, it will
 								attempt to start on a line boundry, and may return less than <cite>size</cite> kbytes.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.uuid_status">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_status" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the details of a specific UUID compose</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>Details about the build</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Returns the same dict as <cite>compose_details()</cite></p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.queue.uuid_tar">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.queue.</span></code><code class="sig-name descname"><span class="pre">uuid_tar</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_tar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.queue.uuid_tar" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a tar of the build data</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>uuid</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The UUID of the build</p></li>
 								<li><p><strong>metadata</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – Set to true to include all the metadata needed to reproduce the build</p></li>
 								<li><p><strong>image</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – Set to true to include the output image</p></li>
 								<li><p><strong>logs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – Set to true to include the logs from the build</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A stream of bytes from tar</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>A generator</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>RuntimeError if there was a problem (eg. missing config file)</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>This yields an uncompressed tar’s data to the caller. It includes
 								the selected data to the caller by returning the Popen stdout from the tar process.</p>
 								</dd></dl>
 								</div>
 								<div class="section" id="module-pylorax.api.recipes">
 								<span id="pylorax-api-recipes-module"></span><h2>pylorax.api.recipes module<a class="headerlink" href="#module-pylorax.api.recipes" title="Permalink to this headline">¶</a></h2>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py class">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.CommitDetails">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">CommitDetails</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">commit</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">revision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#CommitDetails"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.CommitDetails" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Bases: <a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><code class="xref py py-class docutils literal notranslate"><span class="pre">pylorax.base.DataHolder</span></code></a></p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py exception">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.CommitTimeValError">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">CommitTimeValError</span></code><a class="reference internal" href="_modules/pylorax/api/recipes.html#CommitTimeValError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.CommitTimeValError" title="Permalink to this definition">¶</a></dt>
 								<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.NewRecipeGit">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">NewRecipeGit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">toml_dict</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#NewRecipeGit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.NewRecipeGit" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Create a RecipeGit object from fields in a TOML dict</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>rpmname</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Name of the rpm to create, also used as the prefix name in the tar archive</p></li>
 								<li><p><strong>rpmversion</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Version of the rpm, eg. “1.0.0”</p></li>
 								<li><p><strong>rpmrelease</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Release of the rpm, eg. “1”</p></li>
 								<li><p><strong>summary</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Summary string for the rpm</p></li>
 								<li><p><strong>repo</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – URL of the get repo to clone and create the archive from</p></li>
 								<li><p><strong>ref</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Git reference to check out. eg. origin/branch-name, git tag, or git commit hash</p></li>
 								<li><p><strong>destination</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Path to install the / of the git repo at when installing the rpm</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A populated RecipeGit object</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.RecipeGit" title="pylorax.api.recipes.RecipeGit">RecipeGit</a></p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>The TOML should look like this:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">repos</span><span class="o">.</span><span class="n">git</span><span class="p">]]</span>
 								<span class="n">rpmname</span><span class="o">=</span><span class="s2">&quot;server-config&quot;</span>
 								<span class="n">rpmversion</span><span class="o">=</span><span class="s2">&quot;1.0&quot;</span>
 								<span class="n">rpmrelease</span><span class="o">=</span><span class="s2">&quot;1&quot;</span>
 								<span class="n">summary</span><span class="o">=</span><span class="s2">&quot;Setup files for server deployment&quot;</span>
 								<span class="n">repo</span><span class="o">=</span><span class="s2">&quot;PATH OF GIT REPO TO CLONE&quot;</span>
 								<span class="n">ref</span><span class="o">=</span><span class="s2">&quot;v1.0&quot;</span>
 								<span class="n">destination</span><span class="o">=</span><span class="s2">&quot;/opt/server/&quot;</span>
 								</pre></div>
 								</div>
 								<p>Note that the repo path supports anything that git supports, <a class="reference external" href="file://">file://</a>, <a class="reference external" href="https://">https://</a>, <a class="reference external" href="http://">http://</a></p>
 								<p>Currently there is no support for authentication</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py class">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.Recipe">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">Recipe</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">modules</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">packages</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customizations</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gitrepos</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe" title="Permalink to this definition">¶</a></dt>
 								<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>A Recipe of package and modules</p>
 								<p>This is a subclass of dict that enforces the constructor arguments
 								and adds a .filename property to return the recipe’s filename,
 								and a .toml() function to return the recipe as a TOML string.</p>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.Recipe.bump_version">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-name descname"><span class="pre">bump_version</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">old_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe.bump_version"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe.bump_version" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>semver recipe version number bump</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>old_version</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – An optional old version number</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The new version number or None</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>ValueError</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>If neither have a version, 0.0.1 is returned
 								If there is no old version the new version is checked and returned
 								If there is no new version, but there is a old one, bump its patch level
 								If the old and new versions are the same, bump the patch level
 								If they are different, check and return the new version</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.Recipe.filename">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">filename</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.filename" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the Recipe’s filename</p>
 								<p>Replaces spaces in the name with ‘-‘ and appends .toml</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.Recipe.freeze">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-name descname"><span class="pre">freeze</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deps</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe.freeze"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe.freeze" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a new Recipe with full module and package NEVRA</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>deps</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)"><em>list</em></a><em>(</em>) – A list of dependency NEVRA to use to fill in the modules and packages</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A new Recipe object</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></p>
 								</dd>
 								</dl>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.Recipe.group_names">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">group_names</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.group_names" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the names of the groups.  Groups do not have versions.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.Recipe.module_names">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">module_names</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.module_names" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the names of the modules</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.Recipe.module_nver">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">module_nver</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.module_nver" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the names and version globs of the modules</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.Recipe.package_names">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">package_names</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.package_names" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the names of the packages</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.Recipe.package_nver">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">package_nver</span></code><a class="headerlink" href="#pylorax.api.recipes.Recipe.package_nver" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the names and version globs of the packages</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.Recipe.toml">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-name descname"><span class="pre">toml</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe.toml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe.toml" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the Recipe in TOML format</p>
 								</dd></dl>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py exception">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.RecipeError">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipeError</span></code><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeError" title="Permalink to this definition">¶</a></dt>
 								<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py exception">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.RecipeFileError">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipeFileError</span></code><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeFileError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeFileError" title="Permalink to this definition">¶</a></dt>
 								<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py class">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.RecipeGit">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipeGit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rpmname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rpmversion</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rpmrelease</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">destination</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeGit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeGit" title="Permalink to this definition">¶</a></dt>
 								<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py class">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.RecipeGroup">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipeGroup</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeGroup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeGroup" title="Permalink to this definition">¶</a></dt>
 								<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py class">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.RecipeModule">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipeModule</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeModule"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeModule" title="Permalink to this definition">¶</a></dt>
 								<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py class">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.RecipePackage">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">RecipePackage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipePackage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.RecipePackage" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Bases: <a class="reference internal" href="#pylorax.api.recipes.RecipeModule" title="pylorax.api.recipes.RecipeModule"><code class="xref py py-class docutils literal notranslate"><span class="pre">pylorax.api.recipes.RecipeModule</span></code></a></p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.check_list_case">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">check_list_case</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expected_keys</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_keys</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#check_list_case"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.check_list_case" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Check the case of the recipe keys</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>expected_keys</strong> (<em>list of str</em>) – A list of expected key strings</p></li>
 								<li><p><strong>recipe_keys</strong> (<em>list of str</em>) – A list of the recipe’s key strings</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>list of errors</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>list of str</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.check_recipe_dict">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">check_recipe_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe_dict</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#check_recipe_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.check_recipe_dict" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Check a dict before using it to create a new Recipe</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>recipe_dict</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A plain dict of the recipe</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>True if dict is ok</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>RecipeError</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>This checks a dict to make sure required fields are present,
 								that optional fields are correct, and that other optional fields
 								are of the correct format, when included.</p>
 								<p>This collects all of the errors and returns a single RecipeError with
 								a string that can be presented to users.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.check_required_list">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">check_required_list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lst</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#check_required_list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.check_required_list" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Check a list of dicts for required fields</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>lst</strong> (<em>list of dict</em>) – A list of dicts with fields</p></li>
 								<li><p><strong>fields</strong> (<em>list of str</em>) – A list of field name strings</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A list of error strings</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>list of str</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.commit_recipe">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">commit_recipe</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#commit_recipe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.commit_recipe" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Commit a recipe to a branch</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p><strong>recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – Recipe to commit</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>OId of the new commit</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>Git.OId</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.commit_recipe_directory">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">commit_recipe_directory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">directory</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#commit_recipe_directory"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.commit_recipe_directory" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Commit all *.toml files from a directory, if they aren’t already in git.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>directory</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The directory of *.toml recipes to commit</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>None</p>
 								</dd>
 								<dt class="field-odd">Raises</dt>
 								<dd class="field-odd"><p>Can raise errors from Ggit or RecipeFileError</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Files with Toml or RecipeFileErrors will be skipped, and the remainder will
 								be tried.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.commit_recipe_file">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">commit_recipe_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#commit_recipe_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.commit_recipe_file" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Commit a recipe file to a branch</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Path to the recipe file to commit</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>OId of the new commit</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>Git.OId</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit or RecipeFileError</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.customizations_diff">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">customizations_diff</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">old_recipe</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#customizations_diff"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.customizations_diff" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Diff the customizations sections from two versions of a recipe</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.delete_file">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">delete_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#delete_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.delete_file" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Delete a file from a branch.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to delete</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>OId of the new commit</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>Git.OId</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.delete_recipe">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">delete_recipe</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#delete_recipe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.delete_recipe" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Delete a recipe from a branch.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to delete</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>OId of the new commit</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>Git.OId</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.diff_lists">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">diff_lists</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">old_items</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_items</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#diff_lists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.diff_lists" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the differences between two lists of dicts.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>title</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Title of the entry</p></li>
 								<li><p><strong>field</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Field to use as the key for comparisons</p></li>
 								<li><p><strong>old_items</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)"><em>list</em></a><em>(</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a><em>)</em>) – List of item dicts with “name” field</p></li>
 								<li><p><strong>new_items</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)"><em>list</em></a><em>(</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a><em>)</em>) – List of item dicts with “name” field</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>List of diff dicts with old/new entries</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a>)</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.find_commit_tag">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">find_commit_tag</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#find_commit_tag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.find_commit_tag" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Find the tag that matches the commit_id</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to revert</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p><strong>commit_id</strong> (<em>Git.OId</em>) – The commit id to check</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The tag or None if there isn’t one</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>There should be only 1 tag pointing to a commit, but there may not
 								be a tag at all.</p>
 								<p>The tag will look like: ‘refs/tags/&lt;branch&gt;/&lt;filename&gt;/r&lt;revision&gt;’</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.find_field_value">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">find_field_value</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lst</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#find_field_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.find_field_value" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Find a field matching value in the list of dicts.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>field</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – field to search for</p></li>
 								<li><p><strong>value</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – value to match in the field</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p><strong>lst</strong> (<em>list of dict</em>) – List of dict’s with field</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>First dict with matching field:value, or None</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Used to return a specific entry from a list that looks like this:</p>
 								<p>[{“name”: “one”, “attr”: “green”}, …]</p>
 								<p>find_field_value(“name”, “one”, lst) will return the matching dict.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.find_name">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">find_name</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lst</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#find_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.find_name" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Find the dict matching the name in a list and return it.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Name to search for</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p><strong>lst</strong> (<em>list of dict</em>) – List of dict’s with “name” field</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>First dict with matching name, or None</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>This is just a wrapper for find_field_value with field set to “name”</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.find_recipe_obj">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">find_recipe_obj</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#find_recipe_obj"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.find_recipe_obj" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Find a recipe object</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>path</strong> (<em>list of str</em>) – A list of dict field names</p></li>
 								<li><p><strong>recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – The recipe to search</p></li>
 								<li><p><strong>default</strong> (<em>Any</em>) – The value to return if it is not found</p></li>
 								</ul>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Return the object found by applying the path to the dicts in the recipe, or
 								return the default if it doesn’t exist.</p>
 								<p>eg. {“customizations”: {“hostname”: “foo”, “users”: […]}}</p>
 								<p>find_recipe_obj([“customizations”, “hostname”], recipe, “”)</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.get_commit_details">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">get_commit_details</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">commit</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">revision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#get_commit_details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.get_commit_details" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the details about a specific commit.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>commit</strong> (<em>Git.Commit</em>) – The commit to get details from</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>revision</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Optional commit revision</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>Details about the commit</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.CommitDetails" title="pylorax.api.recipes.CommitDetails">CommitDetails</a></p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>CommitTimeValError or Ggit exceptions</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.get_revision_from_tag">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">get_revision_from_tag</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#get_revision_from_tag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.get_revision_from_tag" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the revision number from a tag</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>tag</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The tag to exract the revision from</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The integer revision or None</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>The revision is the part after the r in ‘branch/filename/rXXX’</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.gfile">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">gfile</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#gfile"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.gfile" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Convert a string path to GFile for use with Git</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.head_commit">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">head_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#head_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.head_commit" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Get the branch’s HEAD Commit Object</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>Branch’s head commit</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>Git.Commit</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.is_commit_tag">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">is_commit_tag</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#is_commit_tag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.is_commit_tag" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Check to see if a tag points to a specific commit.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
 								<li><p><strong>commit_id</strong> (<em>Git.OId</em>) – The commit id to check</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>tag</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The tag to check</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>True if the tag points to the commit, False otherwise</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.is_parent_diff">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">is_parent_diff</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tree</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#is_parent_diff"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.is_parent_diff" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Check to see if the commit is different from its parents</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to revert</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p><strong>tree</strong> (<em>Git.Tree</em>) – The commit’s tree</p></li>
 								<li><p><strong>parent</strong> (<em>Git.Commit</em>) – The commit’s parent commit</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Retuns</dt>
 								<dd class="field-even"><p>True if filename in the commit is different from its parents</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.list_branch_files">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">list_branch_files</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#list_branch_files"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.list_branch_files" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a sorted list of the files on the branch HEAD</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A sorted list of the filenames</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a>)</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.list_commit_files">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">list_commit_files</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#list_commit_files"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.list_commit_files" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a sorted list of the files on a commit</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The commit hash to list</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A sorted list of the filenames</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a>)</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.list_commits">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">list_commits</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#list_commits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.list_commits" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>List the commit history of a file on a branch.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to revert</p></li>
 								<li><p><strong>limit</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – Number of commits to return (0=all)</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A list of commit details</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a>(<a class="reference internal" href="#pylorax.api.recipes.CommitDetails" title="pylorax.api.recipes.CommitDetails">CommitDetails</a>)</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.open_or_create_repo">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">open_or_create_repo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#open_or_create_repo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.open_or_create_repo" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Open an existing repo, or create a new one</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>path</strong> (<em>string</em>) – path to recipe directory</p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A repository object</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>Git.Repository</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>A bare git repo will be created in the git directory of the specified path.
 								If a repo already exists it will be opened and returned instead of
 								creating a new one.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.prepare_commit">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">prepare_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">builder</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#prepare_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.prepare_commit" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Prepare for a commit</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p><strong>builder</strong> (<a class="reference internal" href="pylorax.html#pylorax.treebuilder.TreeBuilder" title="pylorax.treebuilder.TreeBuilder"><em>TreeBuilder</em></a>) – instance of TreeBuilder</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>(Tree, Sig, Ref)</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)">tuple</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.read_commit">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">read_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.read_commit" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the contents of a file on a specific branch or commit.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to read</p></li>
 								<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Optional commit hash</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The commit id, and the contents of the commit</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)">tuple</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a>)</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>If no commit is passed the master:filename is returned, otherwise it will be
 								commit:filename</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.read_commit_spec">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">read_commit_spec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_commit_spec"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.read_commit_spec" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the raw content of the blob specified by the spec</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>spec</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Git revparse spec</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>Contents of the commit</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>eg. To read the README file from master the spec is “master:README”</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.read_recipe_and_id">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">read_recipe_and_id</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_recipe_and_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.read_recipe_and_id" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Read a recipe commit and its id from git</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to read</p></li>
 								<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Optional commit hash</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The commit id, and a Recipe object</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)">tuple</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a>, <a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a>)</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>If no commit is passed the master:filename is returned, otherwise it will be
 								commit:filename</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.read_recipe_commit">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">read_recipe_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_recipe_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.read_recipe_commit" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Read a recipe commit from git and return a Recipe object</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to read</p></li>
 								<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Optional commit hash</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A Recipe object</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>If no commit is passed the master:filename is returned, otherwise it will be
 								commit:filename</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.recipe_diff">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">recipe_diff</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">old_recipe</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_diff"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_diff" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Diff two versions of a recipe</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>old_recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – The old version of the recipe</p></li>
 								<li><p><strong>new_recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – The new version of the recipe</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A list of diff dict entries with old/new</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.9)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)">dict</a>)</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.recipe_filename">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">recipe_filename</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_filename"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_filename" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return the toml filename for a recipe</p>
 								<p>Replaces spaces with ‘-‘ and appends ‘.toml’</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.recipe_from_dict">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">recipe_from_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe_dict</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_from_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_from_dict" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Create a Recipe object from a plain dict.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>recipe_dict</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.9)"><em>dict</em></a>) – A plain dict of the recipe</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A Recipe object</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>RecipeError</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.recipe_from_file">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">recipe_from_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_from_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_from_file" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return a recipe file as a Recipe object</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>recipe_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Path to the recipe fila</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A Recipe object</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.recipe_from_toml">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">recipe_from_toml</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe_str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_from_toml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_from_toml" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Create a Recipe object from a toml string.</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><strong>recipe_str</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The Recipe TOML string</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A Recipe object</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>TomlError</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.repo_file_exists">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">repo_file_exists</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#repo_file_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.repo_file_exists" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return True if the filename exists on the branch</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Filename to check</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>True if the filename exists on the HEAD of the branch, False otherwise.</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.9)">bool</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.revert_file">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">revert_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#revert_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.revert_file" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Revert the contents of a file to that of a previous commit</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – filename to revert</p></li>
 								<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Commit hash</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>OId of the new commit</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>Git.OId</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.revert_recipe">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">revert_recipe</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#revert_recipe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.revert_recipe" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Revert the contents of a recipe to that of a previous commit</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to revert</p></li>
 								<li><p><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Commit hash</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>OId of the new commit</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>Git.OId</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.tag_file_commit">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">tag_file_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#tag_file_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.tag_file_commit" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Tag a file’s most recent commit</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Filename to tag</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>Tag id or None if it failed.</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>Git.OId</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>This uses git tags, of the form <cite>refs/tags/&lt;branch&gt;/&lt;filename&gt;/r&lt;revision&gt;</cite>
 								Only the most recent recipe commit can be tagged to prevent out of order tagging.
 								Revisions start at 1 and increment for each new commit that is tagged.
 								If the commit has already been tagged it will return false.</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.tag_recipe_commit">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">tag_recipe_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#tag_recipe_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.tag_recipe_commit" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Tag a file’s most recent commit</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to tag</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>Tag id or None if it failed.</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>Git.OId</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<p>Uses tag_file_commit()</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.recipes.write_commit">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.recipes.</span></code><code class="sig-name descname"><span class="pre">write_commit</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#write_commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.recipes.write_commit" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Make a new commit to a repository’s branch</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – full path of the file to add</p></li>
 								<li><p><strong>message</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The commit message</p></li>
 								<li><p><strong>content</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The data to write</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>OId of the new commit</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p>Git.OId</p>
 								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>Can raise errors from Ggit</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
 								</div>
 								<div class="section" id="module-pylorax.api.server">
 								<span id="pylorax-api-server-module"></span><h2>pylorax.api.server module<a class="headerlink" href="#module-pylorax.api.server" title="Permalink to this headline">¶</a></h2>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py class">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.server.GitLock">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">pylorax.api.server.</span></code><code class="sig-name descname"><span class="pre">GitLock</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dir</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pylorax.api.server.GitLock" title="Permalink to this definition">¶</a></dt>
 								<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
 								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.server.GitLock.dir">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">dir</span></code><a class="headerlink" href="#pylorax.api.server.GitLock.dir" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Alias for field number 2</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.server.GitLock.lock">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">lock</span></code><a class="headerlink" href="#pylorax.api.server.GitLock.lock" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Alias for field number 1</p>
 								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py method">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.server.GitLock.repo">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">repo</span></code><a class="headerlink" href="#pylorax.api.server.GitLock.repo" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Alias for field number 0</p>
 								</dd></dl>
 								</dd></dl>
 								</div>
 								<div class="section" id="module-pylorax.api.v0">
 								<span id="pylorax-api-v0-module"></span><h2>pylorax.api.v0 module<a class="headerlink" href="#module-pylorax.api.v0" title="Permalink to this headline">¶</a></h2>
 								<p>Setup v0 of the API server</p>
 								<p>v0_api() must be called to setup the API routes for Flask</p>
 								<div class="section" id="status-responses">
 								<h3>Status Responses<a class="headerlink" href="#status-responses" title="Permalink to this headline">¶</a></h3>
 								<p>Some requests only return a status/error response.</p>
 								<blockquote>
 								<div><p>The response will be a status response with <cite>status</cite> set to true, or an
 								error response with it set to false and an error message included.</p>
 								<p>Example response:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="n">true</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								<p>Error response:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;ggit-error: Failed to remove entry. File isn&#39;t in the tree - jboss.toml (-1)&quot;</span><span class="p">]</span>
 								  <span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="n">false</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-routes">
 								<h3>API Routes<a class="headerlink" href="#api-routes" title="Permalink to this headline">¶</a></h3>
 								<p>All of the blueprints routes support the optional <cite>branch</cite> argument. If it is not
 								used then the API will use the <cite>master</cite> branch for blueprints. If you want to create
 								a new branch use the <cite>new</cite> or <cite>workspace</cite> routes with ?branch=&lt;branch-name&gt; to
 								store the new blueprint on the new branch.</p>
 								<div class="section" id="api-v0-blueprints-list">
 								<h4><cite>/api/v0/blueprints/list</cite><a class="headerlink" href="#api-v0-blueprints-list" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>List the available blueprints:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
 								  <span class="s2">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
 								  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="s2">&quot;atlas&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;development&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;http-server&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;jboss&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;kubernetes&quot;</span> <span class="p">],</span>
 								  <span class="s2">&quot;total&quot;</span><span class="p">:</span> <span class="mi">6</span> <span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-blueprints-info-blueprint-names-format-json-toml">
 								<h4><cite>/api/v0/blueprints/info/&lt;blueprint_names&gt;[?format=&lt;json|toml&gt;]</cite><a class="headerlink" href="#api-v0-blueprints-info-blueprint-names-format-json-toml" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return the JSON representation of the blueprint. This includes 3 top level
 								objects.  <cite>changes</cite> which lists whether or not the workspace is different from
 								the most recent commit. <cite>blueprints</cite> which lists the JSON representation of the
 								blueprint, and <cite>errors</cite> which will list any errors, like non-existant blueprints.</p>
 								<p>By default the response is JSON, but if <cite>?format=toml</cite> is included in the URL’s
 								arguments it will return the response as the blueprint’s raw TOML content.
 								<em>Unless</em> there is an error which will only return a 400 and a standard error
 								<a href="#id1"><span class="problematic" id="id2">`Status Response`_</span></a>.</p>
 								<p>If there is an error when JSON is requested the successful blueprints and the
 								errors will both be returned.</p>
 								<p>Example of json response:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;changes&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;changed&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">],</span>
 								  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
 								  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;An example GlusterFS server with samba&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.7.*&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs-cli&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.7.*&quot;</span>
 								        <span class="p">}</span>
 								      <span class="p">],</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;packages&quot;</span><span class="p">:</span> <span class="p">[</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;2ping&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.2.1&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;samba&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;4.2.*&quot;</span>
 								        <span class="p">}</span>
 								      <span class="p">],</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								<p>Error example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;changes&quot;</span><span class="p">:</span> <span class="p">[],</span>
 								  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;ggit-error: the path &#39;missing.toml&#39; does not exist in the given tree (-3)&quot;</span><span class="p">]</span>
 								  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-blueprints-changes-blueprint-names-offset-0-limit-20">
 								<h4><cite>/api/v0/blueprints/changes/&lt;blueprint_names&gt;[?offset=0&amp;limit=20]</cite><a class="headerlink" href="#api-v0-blueprints-changes-blueprint-names-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return the commits to a blueprint. By default it returns the first 20 commits, this
 								can be changed by passing <cite>offset</cite> and/or <cite>limit</cite>. The response will include the
 								commit hash, summary, timestamp, and optionally the revision number. The commit
 								hash can be passed to <cite>/api/v0/blueprints/diff/</cite> to retrieve the exact changes.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
 								  <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
 								  <span class="s2">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
 								  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;changes&quot;</span><span class="p">:</span> <span class="p">[</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;e083921a7ed1cf2eec91ad12b9ad1e70ef3470be&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.6 saved.&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
 								          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-23T00:18:13Z&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;cee5f4c20fc33ea4d54bfecf56f4ad41ad15f4f3&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.5 saved.&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
 								          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-11T01:00:28Z&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;29b492f26ed35d80800b536623bafc51e2f0eff2&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.4 saved.&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
 								          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-11T00:28:30Z&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;03374adbf080fe34f5c6c29f2e49cc2b86958bf2&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.3 saved.&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
 								          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-10T23:15:52Z&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;0e08ecbb708675bfabc82952599a1712a843779d&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.2 saved.&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
 								          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-10T23:14:56Z&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;3e11eb87a63d289662cba4b1804a0947a6843379&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;blueprint glusterfs, version 0.0.1 saved.&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;revision&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
 								          <span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-11-08T00:02:47Z&quot;</span>
 								        <span class="p">}</span>
 								      <span class="p">],</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;total&quot;</span><span class="p">:</span> <span class="mi">6</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="post-api-v0-blueprints-new">
 								<h4>POST <cite>/api/v0/blueprints/new</cite><a class="headerlink" href="#post-api-v0-blueprints-new" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Create a new blueprint, or update an existing blueprint. This supports both JSON and TOML
 								for the blueprint format. The blueprint should be in the body of the request with the
 								<cite>Content-Type</cite> header set to either <cite>application/json</cite> or <cite>text/x-toml</cite>.</p>
 								<p>The response will be a status response with <cite>status</cite> set to true, or an
 								error response with it set to false and an error message included.</p>
 								</div></blockquote>
 								</div>
 								<div class="section" id="delete-api-v0-blueprints-delete-blueprint-name">
 								<h4>DELETE <cite>/api/v0/blueprints/delete/&lt;blueprint_name&gt;</cite><a class="headerlink" href="#delete-api-v0-blueprints-delete-blueprint-name" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Delete a blueprint. The blueprint is deleted from the branch, and will no longer
 								be listed by the <cite>list</cite> route. A blueprint can be undeleted using the <cite>undo</cite> route
 								to revert to a previous commit. This will also delete the workspace copy of the
 								blueprint.</p>
 								<p>The response will be a status response with <cite>status</cite> set to true, or an
 								error response with it set to false and an error message included.</p>
 								</div></blockquote>
 								</div>
 								<div class="section" id="post-api-v0-blueprints-workspace">
 								<h4>POST <cite>/api/v0/blueprints/workspace</cite><a class="headerlink" href="#post-api-v0-blueprints-workspace" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Write a blueprint to the temporary workspace. This works exactly the same as <cite>new</cite> except
 								that it does not create a commit. JSON and TOML bodies are supported.</p>
 								<p>The workspace is meant to be used as a temporary blueprint storage for clients.
 								It will be read by the <cite>info</cite> and <cite>diff</cite> routes if it is different from the
 								most recent commit.</p>
 								<p>The response will be a status response with <cite>status</cite> set to true, or an
 								error response with it set to false and an error message included.</p>
 								</div></blockquote>
 								</div>
 								<div class="section" id="delete-api-v0-blueprints-workspace-blueprint-name">
 								<h4>DELETE <cite>/api/v0/blueprints/workspace/&lt;blueprint_name&gt;</cite><a class="headerlink" href="#delete-api-v0-blueprints-workspace-blueprint-name" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Remove the temporary workspace copy of a blueprint. The <cite>info</cite> route will now
 								return the most recent commit of the blueprint. Any changes that were in the
 								workspace will be lost.</p>
 								<p>The response will be a status response with <cite>status</cite> set to true, or an
 								error response with it set to false and an error message included.</p>
 								</div></blockquote>
 								</div>
 								<div class="section" id="post-api-v0-blueprints-undo-blueprint-name-commit">
 								<h4>POST <cite>/api/v0/blueprints/undo/&lt;blueprint_name&gt;/&lt;commit&gt;</cite><a class="headerlink" href="#post-api-v0-blueprints-undo-blueprint-name-commit" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>This will revert the blueprint to a previous commit. The commit hash from the <cite>changes</cite>
 								route can be used in this request.</p>
 								<p>The response will be a status response with <cite>status</cite> set to true, or an
 								error response with it set to false and an error message included.</p>
 								</div></blockquote>
 								</div>
 								<div class="section" id="post-api-v0-blueprints-tag-blueprint-name">
 								<h4>POST <cite>/api/v0/blueprints/tag/&lt;blueprint_name&gt;</cite><a class="headerlink" href="#post-api-v0-blueprints-tag-blueprint-name" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Tag a blueprint as a new release. This uses git tags with a special format.
 								<cite>refs/tags/&lt;branch&gt;/&lt;filename&gt;/r&lt;revision&gt;</cite>. Only the most recent blueprint commit
 								can be tagged. Revisions start at 1 and increment for each new tag
 								(per-blueprint). If the commit has already been tagged it will return false.</p>
 								<p>The response will be a status response with <cite>status</cite> set to true, or an
 								error response with it set to false and an error message included.</p>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-blueprints-diff-blueprint-name-from-commit-to-commit">
 								<h4><cite>/api/v0/blueprints/diff/&lt;blueprint_name&gt;/&lt;from_commit&gt;/&lt;to_commit&gt;</cite><a class="headerlink" href="#api-v0-blueprints-diff-blueprint-name-from-commit-to-commit" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return the differences between two commits, or the workspace. The commit hash
 								from the <cite>changes</cite> response can be used here, or several special strings:</p>
 								<ul class="simple">
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p>NEWEST will select the newest git commit. This works for <cite>from_commit</cite> or <cite>to_commit</cite></p></li>
 								<li><p>WORKSPACE will select the workspace copy. This can only be used in <cite>to_commit</cite></p></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</ul>
 								<p>eg. <cite>/api/v0/blueprints/diff/glusterfs/NEWEST/WORKSPACE</cite> will return the differences
 								between the most recent git commit and the contents of the workspace.</p>
 								<p>Each entry in the response’s diff object contains the old blueprint value and the new one.
 								If old is null and new is set, then it was added.
 								If new is null and old is set, then it was removed.
 								If both are set, then it was changed.</p>
 								<p>The old/new entries will have the name of the blueprint field that was changed. This
 								can be one of: Name, Description, Version, Module, or Package.
 								The contents for these will be the old/new values for them.</p>
 								<p>In the example below the version was changed and the ping package was added.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;diff&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;new&quot;</span><span class="p">:</span> <span class="p">{</span>
 								        <span class="s2">&quot;Version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
 								      <span class="p">},</span>
 								      <span class="s2">&quot;old&quot;</span><span class="p">:</span> <span class="p">{</span>
 								        <span class="s2">&quot;Version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.5&quot;</span>
 								      <span class="p">}</span>
 								    <span class="p">},</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;new&quot;</span><span class="p">:</span> <span class="p">{</span>
 								        <span class="s2">&quot;Package&quot;</span><span class="p">:</span> <span class="p">{</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;ping&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.2.1&quot;</span>
 								        <span class="p">}</span>
 								      <span class="p">},</span>
 								      <span class="s2">&quot;old&quot;</span><span class="p">:</span> <span class="n">null</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-blueprints-freeze-blueprint-names">
 								<h4><cite>/api/v0/blueprints/freeze/&lt;blueprint_names&gt;</cite><a class="headerlink" href="#api-v0-blueprints-freeze-blueprint-names" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return a JSON representation of the blueprint with the package and module versions set
 								to the exact versions chosen by depsolving the blueprint.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
 								  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="p">{</span>
 								        <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;An example GlusterFS server with samba&quot;</span><span class="p">,</span>
 								        <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
 								          <span class="p">{</span>
 								            <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.8.4-18.4.el7.x86_64&quot;</span>
 								          <span class="p">},</span>
 								          <span class="p">{</span>
 								            <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs-cli&quot;</span><span class="p">,</span>
 								            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.8.4-18.4.el7.x86_64&quot;</span>
 								          <span class="p">}</span>
 								        <span class="p">],</span>
 								        <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								        <span class="s2">&quot;packages&quot;</span><span class="p">:</span> <span class="p">[</span>
 								          <span class="p">{</span>
 								            <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;ping&quot;</span><span class="p">,</span>
 								            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;2:3.2.1-2.el7.noarch&quot;</span>
 								          <span class="p">},</span>
 								          <span class="p">{</span>
 								            <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;samba&quot;</span><span class="p">,</span>
 								            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;4.6.2-8.el7.x86_64&quot;</span>
 								          <span class="p">}</span>
 								        <span class="p">],</span>
 								        <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
 								      <span class="p">}</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-blueprints-depsolve-blueprint-names">
 								<h4><cite>/api/v0/blueprints/depsolve/&lt;blueprint_names&gt;</cite><a class="headerlink" href="#api-v0-blueprints-depsolve-blueprint-names" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Depsolve the blueprint using yum, return the blueprint used, and the NEVRAs of the packages
 								chosen to satisfy the blueprint’s requirements. The response will include a list of results,
 								with the full dependency list in <cite>dependencies</cite>, the NEVRAs for the blueprint’s direct modules
 								and packages in <cite>modules</cite>, and any error will be in <cite>errors</cite>.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
 								  <span class="s2">&quot;blueprints&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;dependencies&quot;</span><span class="p">:</span> <span class="p">[</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;noarch&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;2ping&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;2.el7&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.2.1&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;acl&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;12.el7&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;2.2.51&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;audit-libs&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;3.el7&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;2.7.6&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;avahi-libs&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;17.el7&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.6.31&quot;</span>
 								        <span class="p">},</span>
 								        <span class="o">...</span>
 								      <span class="p">],</span>
 								      <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;noarch&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;2ping&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;2.el7&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.2.1&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;18.4.el7&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.8.4&quot;</span>
 								        <span class="p">},</span>
 								        <span class="o">...</span>
 								      <span class="p">],</span>
 								      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="p">{</span>
 								        <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;An example GlusterFS server with samba&quot;</span><span class="p">,</span>
 								        <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
 								          <span class="p">{</span>
 								            <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.7.*&quot;</span>
 								          <span class="p">},</span>
 								       <span class="o">...</span>
 								      <span class="p">}</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-projects-list-offset-0-limit-20">
 								<h4><cite>/api/v0/projects/list[?offset=0&amp;limit=20]</cite><a class="headerlink" href="#api-v0-projects-list-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>List all of the available projects. By default this returns the first 20 items,
 								but this can be changed by setting the <cite>offset</cite> and <cite>limit</cite> arguments.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
 								  <span class="s2">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
 								  <span class="s2">&quot;projects&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;0 A.D. (pronounced &quot;</span><span class="n">zero</span> <span class="n">ey</span><span class="o">-</span><span class="n">dee</span><span class="s2">&quot;) is a ...&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;homepage&quot;</span><span class="p">:</span> <span class="s2">&quot;http://play0ad.com&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;0ad&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;summary&quot;</span><span class="p">:</span> <span class="s2">&quot;Cross-Platform RTS Game of Ancient Warfare&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;upstream_vcs&quot;</span><span class="p">:</span> <span class="s2">&quot;UPSTREAM_VCS&quot;</span>
 								    <span class="p">},</span>
 								    <span class="o">...</span>
 								  <span class="p">],</span>
 								  <span class="s2">&quot;total&quot;</span><span class="p">:</span> <span class="mi">21770</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-projects-info-project-names">
 								<h4><cite>/api/v0/projects/info/&lt;project_names&gt;</cite><a class="headerlink" href="#api-v0-projects-info-project-names" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return information about the comma-separated list of projects. It includes the description
 								of the package along with the list of available builds.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;projects&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;builds&quot;</span><span class="p">:</span> <span class="p">[</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;build_config_ref&quot;</span><span class="p">:</span> <span class="s2">&quot;BUILD_CONFIG_REF&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;build_env_ref&quot;</span><span class="p">:</span> <span class="s2">&quot;BUILD_ENV_REF&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;build_time&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-03-01T08:39:23&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;changelog&quot;</span><span class="p">:</span> <span class="s2">&quot;- restore incremental backups correctly, files ...&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;2&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;metadata&quot;</span><span class="p">:</span> <span class="p">{},</span>
 								          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;32.el7&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;source&quot;</span><span class="p">:</span> <span class="p">{</span>
 								            <span class="s2">&quot;license&quot;</span><span class="p">:</span> <span class="s2">&quot;GPLv3+&quot;</span><span class="p">,</span>
 								            <span class="s2">&quot;metadata&quot;</span><span class="p">:</span> <span class="p">{},</span>
 								            <span class="s2">&quot;source_ref&quot;</span><span class="p">:</span> <span class="s2">&quot;SOURCE_REF&quot;</span><span class="p">,</span>
 								            <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;1.26&quot;</span>
 								          <span class="p">}</span>
 								        <span class="p">}</span>
 								      <span class="p">],</span>
 								      <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;The GNU tar program saves many ...&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;homepage&quot;</span><span class="p">:</span> <span class="s2">&quot;http://www.gnu.org/software/tar/&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;tar&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;summary&quot;</span><span class="p">:</span> <span class="s2">&quot;A GNU file archiving program&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;upstream_vcs&quot;</span><span class="p">:</span> <span class="s2">&quot;UPSTREAM_VCS&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-projects-depsolve-project-names">
 								<h4><cite>/api/v0/projects/depsolve/&lt;project_names&gt;</cite><a class="headerlink" href="#api-v0-projects-depsolve-project-names" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Depsolve the comma-separated list of projects and return the list of NEVRAs needed
 								to satisfy the request.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;projects&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;noarch&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;basesystem&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;7.el7&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;10.0&quot;</span>
 								    <span class="p">},</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;bash&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;28.el7&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;4.2.46&quot;</span>
 								    <span class="p">},</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;filesystem&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;21.el7&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;3.2&quot;</span>
 								    <span class="p">},</span>
 								    <span class="o">...</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-projects-source-list">
 								<h4><cite>/api/v0/projects/source/list</cite><a class="headerlink" href="#api-v0-projects-source-list" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return the list of repositories used for depsolving and installing packages.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;sources&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="s2">&quot;fedora&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;fedora-cisco-openh264&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;fedora-updates-testing&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;fedora-updates&quot;</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-projects-source-info-source-names">
 								<h4><cite>/api/v0/projects/source/info/&lt;source-names&gt;</cite><a class="headerlink" href="#api-v0-projects-source-info-source-names" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return information about the comma-separated list of source names. Or all of the
 								sources if ‘*’ is passed. Note that general globbing is not supported, only ‘*’.</p>
 								<p>immutable system sources will have the “system” field set to true. User added sources
 								will have it set to false. System sources cannot be changed or deleted.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
 								  <span class="s2">&quot;sources&quot;</span><span class="p">:</span> <span class="p">{</span>
 								    <span class="s2">&quot;fedora&quot;</span><span class="p">:</span> <span class="p">{</span>
 								      <span class="s2">&quot;check_gpg&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
 								      <span class="s2">&quot;check_ssl&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
 								      <span class="s2">&quot;gpgkey_urls&quot;</span><span class="p">:</span> <span class="p">[</span>
 								        <span class="s2">&quot;file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64&quot;</span>
 								      <span class="p">],</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;fedora&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;proxy&quot;</span><span class="p">:</span> <span class="s2">&quot;http://proxy.brianlane.com:8123&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;system&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
 								      <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;yum-metalink&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="s2">&quot;https://mirrors.fedoraproject.org/metalink?repo=fedora-28&amp;arch=x86_64&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">}</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="post-api-v0-projects-source-new">
 								<h4>POST <cite>/api/v0/projects/source/new</cite><a class="headerlink" href="#post-api-v0-projects-source-new" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Add (or change) a source for use when depsolving blueprints and composing images.</p>
 								<p>The <code class="docutils literal notranslate"><span class="pre">proxy</span></code> and <code class="docutils literal notranslate"><span class="pre">gpgkey_urls</span></code> entries are optional. All of the others are required. The supported
 								types for the urls are:</p>
 								<ul class="simple">
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p><code class="docutils literal notranslate"><span class="pre">yum-baseurl</span></code> is a URL to a yum repository.</p></li>
 								<li><p><code class="docutils literal notranslate"><span class="pre">yum-mirrorlist</span></code> is a URL for a mirrorlist.</p></li>
 								<li><p><code class="docutils literal notranslate"><span class="pre">yum-metalink</span></code> is a URL for a metalink.</p></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</ul>
 								<p>If <code class="docutils literal notranslate"><span class="pre">check_ssl</span></code> is true the https certificates must be valid. If they are self-signed you can either set
 								this to false, or add your Certificate Authority to the host system.</p>
 								<p>If <code class="docutils literal notranslate"><span class="pre">check_gpg</span></code> is true the GPG key must either be installed on the host system, or <code class="docutils literal notranslate"><span class="pre">gpgkey_urls</span></code>
 								should point to it.</p>
 								<p>You can edit an existing source (other than system sources), by doing a POST
 								of the new version of the source. It will overwrite the previous one.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								    <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;custom-source-1&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="s2">&quot;https://url/path/to/repository/&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;yum-baseurl&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;check_ssl&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
 								    <span class="s2">&quot;check_gpg&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
 								    <span class="s2">&quot;gpgkey_urls&quot;</span><span class="p">:</span> <span class="p">[</span>
 								        <span class="s2">&quot;https://url/path/to/gpg-key&quot;</span>
 								    <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="delete-api-v0-projects-source-delete-source-name">
 								<h4>DELETE <cite>/api/v0/projects/source/delete/&lt;source-name&gt;</cite><a class="headerlink" href="#delete-api-v0-projects-source-delete-source-name" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Delete a user added source. This will fail if a system source is passed to
 								it.</p>
 								<p>The response will be a status response with <cite>status</cite> set to true, or an
 								error response with it set to false and an error message included.</p>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-modules-list-offset-0-limit-20">
 								<h4><cite>/api/v0/modules/list[?offset=0&amp;limit=20]</cite><a class="headerlink" href="#api-v0-modules-list-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return a list of all of the available modules. This includes the name and the
 								group_type, which is always “rpm” for lorax-composer. By default this returns
 								the first 20 items. This can be changed by setting the <cite>offset</cite> and <cite>limit</cite>
 								arguments.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
 								  <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;group_type&quot;</span><span class="p">:</span> <span class="s2">&quot;rpm&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;0ad&quot;</span>
 								    <span class="p">},</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;group_type&quot;</span><span class="p">:</span> <span class="s2">&quot;rpm&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;0ad-data&quot;</span>
 								    <span class="p">},</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;group_type&quot;</span><span class="p">:</span> <span class="s2">&quot;rpm&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;0install&quot;</span>
 								    <span class="p">},</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;group_type&quot;</span><span class="p">:</span> <span class="s2">&quot;rpm&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;2048-cli&quot;</span>
 								    <span class="p">},</span>
 								    <span class="o">...</span>
 								  <span class="p">]</span>
 								  <span class="s2">&quot;total&quot;</span><span class="p">:</span> <span class="mi">21770</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-modules-list-module-names-offset-0-limit-20">
 								<h4><cite>/api/v0/modules/list/&lt;module_names&gt;[?offset=0&amp;limit=20]</cite><a class="headerlink" href="#api-v0-modules-list-module-names-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return the list of comma-separated modules. Output is the same as <cite>/modules/list</cite></p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
 								  <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;group_type&quot;</span><span class="p">:</span> <span class="s2">&quot;rpm&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;tar&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">],</span>
 								  <span class="s2">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
 								  <span class="s2">&quot;total&quot;</span><span class="p">:</span> <span class="mi">1</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-modules-info-module-names">
 								<h4><cite>/api/v0/modules/info/&lt;module_names&gt;</cite><a class="headerlink" href="#api-v0-modules-info-module-names" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return the module’s dependencies, and the information about the module.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;modules&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;dependencies&quot;</span><span class="p">:</span> <span class="p">[</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;noarch&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;basesystem&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;7.el7&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;10.0&quot;</span>
 								        <span class="p">},</span>
 								        <span class="p">{</span>
 								          <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;bash&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;28.el7&quot;</span><span class="p">,</span>
 								          <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;4.2.46&quot;</span>
 								        <span class="p">},</span>
 								        <span class="o">...</span>
 								      <span class="p">],</span>
 								      <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;The GNU tar program saves ...&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;homepage&quot;</span><span class="p">:</span> <span class="s2">&quot;http://www.gnu.org/software/tar/&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;tar&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;summary&quot;</span><span class="p">:</span> <span class="s2">&quot;A GNU file archiving program&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;upstream_vcs&quot;</span><span class="p">:</span> <span class="s2">&quot;UPSTREAM_VCS&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="post-api-v0-compose">
 								<h4>POST <cite>/api/v0/compose</cite><a class="headerlink" href="#post-api-v0-compose" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Start a compose. The content type should be ‘application/json’ and the body of the POST
 								should look like this:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;blueprint_name&quot;</span><span class="p">:</span> <span class="s2">&quot;http-server&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;compose_type&quot;</span><span class="p">:</span> <span class="s2">&quot;tar&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;branch&quot;</span><span class="p">:</span> <span class="s2">&quot;master&quot;</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								<p>Pass it the name of the blueprint, the type of output (from ‘/api/v0/compose/types’), and the
 								blueprint branch to use. ‘branch’ is optional and will default to master. It will create a new
 								build and add it to the queue. It returns the build uuid and a status if it succeeds:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;build_id&quot;</span><span class="p">:</span> <span class="s2">&quot;e6fa6db4-9c81-4b70-870f-a697ca405cdf&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="n">true</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-compose-types">
 								<h4><cite>/api/v0/compose/types</cite><a class="headerlink" href="#api-v0-compose-types" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Returns the list of supported output types that are valid for use with ‘POST /api/v0/compose’</p>
 								<blockquote>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<div><dl>
 								<dt>{</dt><dd><dl>
 								<dt>“types”: [</dt><dd><dl class="simple">
 								<dt>{</dt><dd><p>“enabled”: true,
 								“name”: “tar”</p>
 								</dd>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dl>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<p>}</p>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd>
 								</dl>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<p>]</p>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd>
 								</dl>
 								<p>}</p>
 								</div></blockquote>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-compose-queue">
 								<h4><cite>/api/v0/compose/queue</cite><a class="headerlink" href="#api-v0-compose-queue" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return the status of the build queue. It includes information about the builds waiting,
 								and the build that is running.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;new&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;45502a6d-06e8-48a5-a215-2b4174b3614b&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;WAITING&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517362647.4570868</span><span class="p">,</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
 								    <span class="p">},</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;6d292bd0-bec7-4825-8d7d-41ef9c3e4b73&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;kubernetes&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;WAITING&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517362659.0034983</span><span class="p">,</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.1&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">],</span>
 								  <span class="s2">&quot;run&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;745712b2-96db-44c0-8014-fe925c35e795&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;RUNNING&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517362633.7965999</span><span class="p">,</span>
 								      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517362633.8001345</span><span class="p">,</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-compose-finished">
 								<h4><cite>/api/v0/compose/finished</cite><a class="headerlink" href="#api-v0-compose-finished" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return the details on all of the finished composes on the system.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;finished&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;70b84195-9817-4b8a-af92-45e380f39894&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FINISHED&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517351003.8210032</span><span class="p">,</span>
 								      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517351003.8230415</span><span class="p">,</span>
 								      <span class="s2">&quot;job_finished&quot;</span><span class="p">:</span> <span class="mf">1517359234.1003145</span><span class="p">,</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
 								    <span class="p">},</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;e695affd-397f-4af9-9022-add2636e7459&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FINISHED&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517362289.7193348</span><span class="p">,</span>
 								      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517362289.9751132</span><span class="p">,</span>
 								      <span class="s2">&quot;job_finished&quot;</span><span class="p">:</span> <span class="mf">1517363500.1234567</span><span class="p">,</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-compose-failed">
 								<h4><cite>/api/v0/compose/failed</cite><a class="headerlink" href="#api-v0-compose-failed" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return the details on all of the failed composes on the system.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;failed&quot;</span><span class="p">:</span> <span class="p">[</span>
 								     <span class="p">{</span>
 								      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;8c8435ef-d6bd-4c68-9bf1-a2ef832e6b1a&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;http-server&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FAILED&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517523249.9301329</span><span class="p">,</span>
 								      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517523249.9314211</span><span class="p">,</span>
 								      <span class="s2">&quot;job_finished&quot;</span><span class="p">:</span> <span class="mf">1517523255.5623411</span><span class="p">,</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.2&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-compose-status-uuids-blueprint-blueprint-name-status-compose-status-type-compose-type">
 								<h4><cite>/api/v0/compose/status/&lt;uuids&gt;[?blueprint=&lt;blueprint_name&gt;&amp;status=&lt;compose_status&gt;&amp;type=&lt;compose_type&gt;]</cite><a class="headerlink" href="#api-v0-compose-status-uuids-blueprint-blueprint-name-status-compose-status-type-compose-type" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Return the details for each of the comma-separated list of uuids. A uuid of ‘*’ will return
 								details for all composes.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;uuids&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;8c8435ef-d6bd-4c68-9bf1-a2ef832e6b1a&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;http-server&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FINISHED&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517523644.2384307</span><span class="p">,</span>
 								      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517523644.2551234</span><span class="p">,</span>
 								      <span class="s2">&quot;job_finished&quot;</span><span class="p">:</span> <span class="mf">1517523689.9864314</span><span class="p">,</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.2&quot;</span>
 								    <span class="p">},</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;45502a6d-06e8-48a5-a215-2b4174b3614b&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="s2">&quot;glusterfs&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FINISHED&quot;</span><span class="p">,</span>
 								      <span class="s2">&quot;job_created&quot;</span><span class="p">:</span> <span class="mf">1517363442.188399</span><span class="p">,</span>
 								      <span class="s2">&quot;job_started&quot;</span><span class="p">:</span> <span class="mf">1517363442.325324</span><span class="p">,</span>
 								      <span class="s2">&quot;job_finished&quot;</span><span class="p">:</span> <span class="mf">1517363451.653621</span><span class="p">,</span>
 								      <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;0.0.6&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="delete-api-v0-compose-cancel-uuid">
 								<h4>DELETE <cite>/api/v0/compose/cancel/&lt;uuid&gt;</cite><a class="headerlink" href="#delete-api-v0-compose-cancel-uuid" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Cancel the build, if it is not finished, and delete the results. It will return a
 								status of True if it is successful.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
 								  <span class="s2">&quot;uuid&quot;</span><span class="p">:</span> <span class="s2">&quot;03397f8d-acff-4cdb-bd31-f629b7a948f5&quot;</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="delete-api-v0-compose-delete-uuids">
 								<h4>DELETE <cite>/api/v0/compose/delete/&lt;uuids&gt;</cite><a class="headerlink" href="#delete-api-v0-compose-delete-uuids" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Delete the list of comma-separated uuids from the compose results.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;errors&quot;</span><span class="p">:</span> <span class="p">[],</span>
 								  <span class="s2">&quot;uuids&quot;</span><span class="p">:</span> <span class="p">[</span>
 								    <span class="p">{</span>
 								      <span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
 								      <span class="s2">&quot;uuid&quot;</span><span class="p">:</span> <span class="s2">&quot;ae1bf7e3-7f16-4c9f-b36e-3726a1093fd0&quot;</span>
 								    <span class="p">}</span>
 								  <span class="p">]</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-compose-info-uuid">
 								<h4><cite>/api/v0/compose/info/&lt;uuid&gt;</cite><a class="headerlink" href="#api-v0-compose-info-uuid" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Get detailed information about the compose. The returned JSON string will
 								contain the following information:</p>
 								<blockquote>
 								<div><ul class="simple">
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p>id - The uuid of the comoposition</p></li>
 								<li><p>config - containing the configuration settings used to run Anaconda</p></li>
 								<li><p>blueprint - The depsolved blueprint used to generate the kickstart</p></li>
 								<li><p>commit - The (local) git commit hash for the blueprint used</p></li>
 								<li><p>deps - The NEVRA of all of the dependencies used in the composition</p></li>
 								<li><p>compose_type - The type of output generated (tar, iso, etc.)</p></li>
 								<li><p>queue_status - The final status of the composition (FINISHED or FAILED)</p></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</ul>
 								</div></blockquote>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
 								  <span class="s2">&quot;commit&quot;</span><span class="p">:</span> <span class="s2">&quot;7078e521a54b12eae31c3fd028680da7a0815a4d&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;compose_type&quot;</span><span class="p">:</span> <span class="s2">&quot;tar&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;config&quot;</span><span class="p">:</span> <span class="p">{</span>
 								    <span class="s2">&quot;anaconda_args&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;armplatform&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;compress_args&quot;</span><span class="p">:</span> <span class="p">[],</span>
 								    <span class="s2">&quot;compression&quot;</span><span class="p">:</span> <span class="s2">&quot;xz&quot;</span><span class="p">,</span>
 								    <span class="s2">&quot;image_name&quot;</span><span class="p">:</span> <span class="s2">&quot;root.tar.xz&quot;</span><span class="p">,</span>
 								    <span class="o">...</span>
 								  <span class="p">},</span>
 								  <span class="s2">&quot;deps&quot;</span><span class="p">:</span> <span class="p">{</span>
 								    <span class="s2">&quot;packages&quot;</span><span class="p">:</span> <span class="p">[</span>
 								      <span class="p">{</span>
 								        <span class="s2">&quot;arch&quot;</span><span class="p">:</span> <span class="s2">&quot;x86_64&quot;</span><span class="p">,</span>
 								        <span class="s2">&quot;epoch&quot;</span><span class="p">:</span> <span class="s2">&quot;0&quot;</span><span class="p">,</span>
 								        <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;acl&quot;</span><span class="p">,</span>
 								        <span class="s2">&quot;release&quot;</span><span class="p">:</span> <span class="s2">&quot;14.el7&quot;</span><span class="p">,</span>
 								        <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="s2">&quot;2.2.51&quot;</span>
 								      <span class="p">}</span>
 								    <span class="p">]</span>
 								  <span class="p">},</span>
 								  <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;c30b7d80-523b-4a23-ad52-61b799739ce8&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;queue_status&quot;</span><span class="p">:</span> <span class="s2">&quot;FINISHED&quot;</span><span class="p">,</span>
 								  <span class="s2">&quot;blueprint&quot;</span><span class="p">:</span> <span class="p">{</span>
 								    <span class="s2">&quot;description&quot;</span><span class="p">:</span> <span class="s2">&quot;An example kubernetes master&quot;</span><span class="p">,</span>
 								    <span class="o">...</span>
 								  <span class="p">}</span>
 								<span class="p">}</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-compose-metadata-uuid">
 								<h4><cite>/api/v0/compose/metadata/&lt;uuid&gt;</cite><a class="headerlink" href="#api-v0-compose-metadata-uuid" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Returns a .tar of the metadata used for the build. This includes all the
 								information needed to reproduce the build, including the final kickstart
 								populated with repository and package NEVRA.</p>
 								<p>The mime type is set to ‘application/x-tar’ and the filename is set to
 								UUID-metadata.tar</p>
 								<p>The .tar is uncompressed, but is not large.</p>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-compose-results-uuid">
 								<h4><cite>/api/v0/compose/results/&lt;uuid&gt;</cite><a class="headerlink" href="#api-v0-compose-results-uuid" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Returns a .tar of the metadata, logs, and output image of the build. This
 								includes all the information needed to reproduce the build, including the
 								final kickstart populated with repository and package NEVRA. The output image
 								is already in compressed form so the returned tar is not compressed.</p>
 								<p>The mime type is set to ‘application/x-tar’ and the filename is set to
 								UUID.tar</p>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-compose-logs-uuid">
 								<h4><cite>/api/v0/compose/logs/&lt;uuid&gt;</cite><a class="headerlink" href="#api-v0-compose-logs-uuid" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Returns a .tar of the anaconda build logs. The tar is not compressed, but is
 								not large.</p>
 								<p>The mime type is set to ‘application/x-tar’ and the filename is set to
 								UUID-logs.tar</p>
 								</div></blockquote>
 								</div>
 								<div class="section" id="api-v0-compose-image-uuid">
 								<h4><cite>/api/v0/compose/image/&lt;uuid&gt;</cite><a class="headerlink" href="#api-v0-compose-image-uuid" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<div><p>Returns the output image from the build. The filename is set to the filename
 								from the build with the UUID as a prefix. eg. UUID-root.tar.xz or UUID-boot.iso.</p>
 								</div></blockquote>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</div>
 								<div class="section" id="api-v0-compose-log-uuid-size-kbytes">
 								<h4><cite>/api/v0/compose/log/&lt;uuid&gt;[?size=kbytes]</cite><a class="headerlink" href="#api-v0-compose-log-uuid-size-kbytes" title="Permalink to this headline">¶</a></h4>
 								<blockquote>
 								<div><p>Returns the end of the anaconda.log. The size parameter is optional and defaults to 1Mbytes
 								if it is not included. The returned data is raw text from the end of the logfile, starting on
 								a line boundry.</p>
 								<p>Example:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">222</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">Thread</span><span class="p">:</span> <span class="n">AnaConfigurationThread</span> <span class="p">(</span><span class="mi">140629395244800</span><span class="p">)</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">223</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">installed</span> <span class="n">system</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">912</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">installed</span> <span class="n">system</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">912</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Creating</span> <span class="n">users</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">913</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Clearing</span> <span class="n">libuser</span><span class="o">.</span><span class="n">conf</span> <span class="n">at</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">libuser</span><span class="o">.</span><span class="n">Dyy8Gj</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">154</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Creating</span> <span class="n">users</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">155</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">addons</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">155</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">addons</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">155</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Generating</span> <span class="n">initramfs</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">49</span><span class="p">,</span><span class="mi">467</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Generating</span> <span class="n">initramfs</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">49</span><span class="p">,</span><span class="mi">467</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">post</span><span class="o">-</span><span class="n">installation</span> <span class="n">scripts</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">49</span><span class="p">,</span><span class="mi">467</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">kickstart</span> <span class="o">%%</span><span class="n">post</span> <span class="n">script</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">50</span><span class="p">,</span><span class="mi">782</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">All</span> <span class="n">kickstart</span> <span class="o">%%</span><span class="n">post</span> <span class="n">script</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="n">have</span> <span class="n">been</span> <span class="n">run</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">50</span><span class="p">,</span><span class="mi">782</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">post</span><span class="o">-</span><span class="n">installation</span> <span class="n">scripts</span>
 								<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">50</span><span class="p">,</span><span class="mi">784</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Thread</span> <span class="n">Done</span><span class="p">:</span> <span class="n">AnaConfigurationThread</span> <span class="p">(</span><span class="mi">140629395244800</span><span class="p">)</span>
 								</pre></div>
 								</div>
 								</div></blockquote>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.v0.blueprint_exists">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.v0.</span></code><code class="sig-name descname"><span class="pre">blueprint_exists</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blueprint_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/v0.html#blueprint_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.v0.blueprint_exists" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Return True if the blueprint exists</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>api</strong> (<em>Flask</em>) – flask object</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Recipe name to read</p></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</ul>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.v0.take_limits">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.v0.</span></code><code class="sig-name descname"><span class="pre">take_limits</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iterable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/v0.html#take_limits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.v0.take_limits" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Apply offset and limit to an iterable object</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>iterable</strong> (<em>iter</em>) – The object to limit</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>offset</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – The number of items to skip</p></li>
 								<li><p><strong>limit</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)"><em>int</em></a>) – The total number of items to return</p></li>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</ul>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>A subset of the iterable</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.v0.v0_api">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.v0.</span></code><code class="sig-name descname"><span class="pre">v0_api</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/v0.html#v0_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.v0.v0_api" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd></dd></dl>
 								</div>
 								</div>
 								</div>
 								<div class="section" id="module-pylorax.api.workspace">
 								<span id="pylorax-api-workspace-module"></span><h2>pylorax.api.workspace module<a class="headerlink" href="#module-pylorax.api.workspace" title="Permalink to this headline">¶</a></h2>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.workspace.workspace_delete">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.workspace.</span></code><code class="sig-name descname"><span class="pre">workspace_delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_delete" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Delete the recipe from the workspace</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The name of the recipe</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>None</p>
 								</dd>
 								<dt class="field-odd">Raises</dt>
 								<dd class="field-odd"><p>IO related errors</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.workspace.workspace_dir">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.workspace.</span></code><code class="sig-name descname"><span class="pre">workspace_dir</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_dir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_dir" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Create the workspace’s path from a Repository and branch</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The path to the branch’s workspace directory</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.workspace.workspace_read">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.workspace.</span></code><code class="sig-name descname"><span class="pre">workspace_read</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_read"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_read" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Read a Recipe from the branch’s workspace</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
 								<li><p><strong>recipe_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – The name of the recipe</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The workspace copy of the recipe, or None if it doesn’t exist</p>
 								</dd>
 								<dt class="field-odd">Return type</dt>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dd class="field-odd"><p><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)">None</a></p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								</dd>
 								<dt class="field-even">Raises</dt>
 								<dd class="field-even"><p>RecipeFileError</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.workspace.workspace_write">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.workspace.</span></code><code class="sig-name descname"><span class="pre">workspace_write</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_write"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_write" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd><p>Write a recipe to the workspace</p>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</p></li>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<li><p><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – Branch name</p></li>
-												Update rhel8-branch documentation

											
										
										
											2020-04-28 17:42:12 +00:00
+								<li><p><strong>recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – The recipe to write to the workspace</p></li>
 								</ul>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>None</p>
 								</dd>
 								<dt class="field-odd">Raises</dt>
 								<dd class="field-odd"><p>IO related errors</p>
 								</dd>
 								</dl>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								</dd></dl>
 								</div>
 								<div class="section" id="module-pylorax.api">
 								<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pylorax.api" title="Permalink to this headline">¶</a></h2>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<dl class="py function">
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dt id="pylorax.api.crossdomain">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								<code class="sig-prename descclassname"><span class="pre">pylorax.api.</span></code><code class="sig-name descname"><span class="pre">crossdomain</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">origin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">methods</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_age</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">21600</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attach_to_all</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">automatic_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/crossdomain.html#crossdomain"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylorax.api.crossdomain" title="Permalink to this definition">¶</a></dt>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								<dd></dd></dl>
 								</div>
 								</div>
 								           </div>
 								          </div>
 								          <footer>
 								    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								        <a href="pylorax.html" class="btn btn-neutral float-left" title="pylorax package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
+								    </div>
 								  <hr/>
 								  <div role="contentinfo">
 								    <p>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
+								        &#169; Copyright 2018-2019, Red Hat, Inc..
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
 								    </p>
 								  </div>
-												Add lorax 28.14.42 documentation

											
										
										
											2021-04-23 22:11:02 +00:00
 								    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
 								    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
 								    provided by <a href="https://readthedocs.org">Read the Docs</a>.
-												Add lorax 28.14.33 documentation

											
										
										
											2019-12-19 22:07:51 +00:00
 								</footer>
 								        </div>
 								      </div>
 								    </section>
 								  </div>
 								  <script type="text/javascript">
 								      jQuery(function () {
 								          SphinxRtdTheme.Navigation.enable(true);
 								      });
 								  </script>
 								</body>
 								</html>