<spanid="pylorax-api-bisect-module"></span><h2>pylorax.api.bisect module<aclass="headerlink"href="#module-pylorax.api.bisect"title="Permalink to this headline">¶</a></h2>
<dlclass="function">
<dtid="pylorax.api.bisect.insort_left">
<codeclass="descclassname">pylorax.api.bisect.</code><codeclass="descname">insort_left</code><spanclass="sig-paren">(</span><em>a</em>, <em>x</em>, <em>key=None</em>, <em>lo=0</em>, <em>hi=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/bisect.html#insort_left"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.bisect.insort_left"title="Permalink to this definition">¶</a></dt>
<dd><p>Insert item x in list a, and keep it sorted assuming a is sorted.</p>
<li><p><strong>x</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#object"title="(in Python v3.7)"><em>object</em></a>) -- item to insert into the list</p></li>
<li><p><strong>key</strong> (<em>function</em>) -- Function to use to compare items in the list</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>index where the item was inserted</p>
<spanid="pylorax-api-checkparams-module"></span><h2>pylorax.api.checkparams module<aclass="headerlink"href="#module-pylorax.api.checkparams"title="Permalink to this headline">¶</a></h2>
<dlclass="function">
<dtid="pylorax.api.checkparams.checkparams">
<codeclass="descclassname">pylorax.api.checkparams.</code><codeclass="descname">checkparams</code><spanclass="sig-paren">(</span><em>tuples</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/checkparams.html#checkparams"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.checkparams.checkparams"title="Permalink to this definition">¶</a></dt>
<spanid="pylorax-api-cmdline-module"></span><h2>pylorax.api.cmdline module<aclass="headerlink"href="#module-pylorax.api.cmdline"title="Permalink to this headline">¶</a></h2>
<codeclass="descclassname">pylorax.api.cmdline.</code><codeclass="descname">lorax_composer_parser</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/cmdline.html#lorax_composer_parser"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.cmdline.lorax_composer_parser"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the ArgumentParser for lorax-composer</p>
<spanid="pylorax-api-compose-module"></span><h2>pylorax.api.compose module<aclass="headerlink"href="#module-pylorax.api.compose"title="Permalink to this headline">¶</a></h2>
<p>Setup for composing an image</p>
<divclass="section"id="adding-new-output-types">
<h3>Adding New Output Types<aclass="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>
<dlclass="function">
<dtid="pylorax.api.compose.add_customizations">
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">add_customizations</code><spanclass="sig-paren">(</span><em>f</em>, <em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#add_customizations"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.add_customizations"title="Permalink to this definition">¶</a></dt>
<dd><p>Add customizations to the kickstart file</p>
<ddclass="field-odd"><p>RuntimeError if there was a problem writing to the kickstart</p>
</dd>
</dl>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.compose.bootloader_append">
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">bootloader_append</code><spanclass="sig-paren">(</span><em>line</em>, <em>kernel_append</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#bootloader_append"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>line</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The bootloader ... line</p></li>
<li><p><strong>kernel_append</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><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>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">compose_args</code><spanclass="sig-paren">(</span><em>compose_type</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#compose_args"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<ddclass="field-odd"><p><strong>compose_type</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The type of compose to create, from <cite>compose_types()</cite></p>
Other options will be filled in by <cite>make_compose()</cite></p>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.compose.compose_types">
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">compose_types</code><spanclass="sig-paren">(</span><em>share_dir</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#compose_types"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.compose_types"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of the supported output types</p>
<p>The output types come from the kickstart names in /usr/share/lorax/composer/*ks</p>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">customize_ks_template</code><spanclass="sig-paren">(</span><em>ks_template</em>, <em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#customize_ks_template"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ks_template</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The kickstart template</p></li>
<p>Add default timezone if needed. It does NOT replace an existing timezone entry</p>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.compose.firewall_cmd">
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">firewall_cmd</code><spanclass="sig-paren">(</span><em>line</em>, <em>settings</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#firewall_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>line</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The firewall ... line</p></li>
<li><p><strong>settings</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)"><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>
<dlclass="function">
<dtid="pylorax.api.compose.get_default_services">
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">get_default_services</code><spanclass="sig-paren">(</span><em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#get_default_services"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>string with "services" or ""</p>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">get_extra_pkgs</code><spanclass="sig-paren">(</span><em>dbo</em>, <em>share_dir</em>, <em>compose_type</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#get_extra_pkgs"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>dbo</strong> (<em>dnf.Base</em>) -- dnf base object</p></li>
<li><p><strong>share_dir</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Path to the top level share directory</p></li>
<li><p><strong>compose_type</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The type of output to create from the recipe</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>List of package names (name only, not NEVRA)</p>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">get_firewall_settings</code><spanclass="sig-paren">(</span><em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#get_firewall_settings"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.get_firewall_settings"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.firewall settings</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) -- The recipe</p>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">get_kernel_append</code><spanclass="sig-paren">(</span><em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#get_kernel_append"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.get_kernel_append"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.kernel append value</p>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">get_keyboard_layout</code><spanclass="sig-paren">(</span><em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#get_keyboard_layout"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.get_keyboard_layout"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.locale.keyboard list</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) -- The recipe</p>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">get_languages</code><spanclass="sig-paren">(</span><em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#get_languages"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.get_languages"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.locale.languages list</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) -- The recipe</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>list of language strings</p>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">get_services</code><spanclass="sig-paren">(</span><em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#get_services"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.get_services"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.services settings</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>recipe</strong> (<em>Recipe object</em>) -- The recipe</p>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">get_timezone_settings</code><spanclass="sig-paren">(</span><em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#get_timezone_settings"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.get_timezone_settings"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the customizations.timezone dict</p>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">keyboard_cmd</code><spanclass="sig-paren">(</span><em>line</em>, <em>layout</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#keyboard_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.keyboard_cmd"title="Permalink to this definition">¶</a></dt>
<dd><p>Update the keyboard line with the layout</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>line</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The keyboard ... line</p></li>
<li><p><strong>settings</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><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>
<dlclass="function">
<dtid="pylorax.api.compose.lang_cmd">
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">lang_cmd</code><spanclass="sig-paren">(</span><em>line</em>, <em>languages</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#lang_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.lang_cmd"title="Permalink to this definition">¶</a></dt>
<dd><p>Update the lang line with the languages</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>line</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The lang ... line</p></li>
<li><p><strong>settings</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#list"title="(in Python v3.7)"><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>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">move_compose_results</code><spanclass="sig-paren">(</span><em>cfg</em>, <em>results_dir</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#move_compose_results"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>results_dir</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Directory to put the results into</p></li>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">repo_to_ks</code><spanclass="sig-paren">(</span><em>r</em>, <em>url='url'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#repo_to_ks"><spanclass="viewcode-link">[source]</span></a><aclass="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.
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">services_cmd</code><spanclass="sig-paren">(</span><em>line</em>, <em>settings</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#services_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>line</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The services ... line</p></li>
<li><p><strong>settings</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)"><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>
<li><p><strong>dnflock</strong> (<em>YumLock</em>) -- Lock and YumBase for depsolving</p></li>
<li><p><strong>recipe</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The recipe to build</p></li>
<li><p><strong>compose_type</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The type of output to create from the recipe</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>Unique ID for the build that can be used to track its status</p>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">test_templates</code><spanclass="sig-paren">(</span><em>dbo</em>, <em>share_dir</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#test_templates"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">timezone_cmd</code><spanclass="sig-paren">(</span><em>line</em>, <em>settings</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#timezone_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.timezone_cmd"title="Permalink to this definition">¶</a></dt>
<dd><p>Update the timezone line with the settings</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>line</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The timezone ... line</p></li>
<li><p><strong>settings</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)"><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>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">write_ks_group</code><spanclass="sig-paren">(</span><em>f</em>, <em>group</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#write_ks_group"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.write_ks_group"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">write_ks_root</code><spanclass="sig-paren">(</span><em>f</em>, <em>user</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#write_ks_root"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>user</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)"><em>dict</em></a>) -- A blueprint user dictionary</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>True if it wrote a rootpw command to the kickstart</p>
<codeclass="descclassname">pylorax.api.compose.</code><codeclass="descname">write_ks_user</code><spanclass="sig-paren">(</span><em>f</em>, <em>user</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/compose.html#write_ks_user"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.compose.write_ks_user"title="Permalink to this definition">¶</a></dt>
<li><p><strong>user</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)"><em>dict</em></a>) -- A blueprint user dictionary</p></li>
<spanid="pylorax-api-config-module"></span><h2>pylorax.api.config module<aclass="headerlink"href="#module-pylorax.api.config"title="Permalink to this headline">¶</a></h2>
<codeclass="descname">get_default</code><spanclass="sig-paren">(</span><em>section</em>, <em>option</em>, <em>default</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/config.html#ComposerConfig.get_default"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.config.ComposerConfig.get_default"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.config.configure">
<codeclass="descclassname">pylorax.api.config.</code><codeclass="descname">configure</code><spanclass="sig-paren">(</span><em>conf_file='/etc/lorax/composer.conf'</em>, <em>root_dir='/'</em>, <em>test_config=False</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/config.html#configure"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.config.configure"title="Permalink to this definition">¶</a></dt>
<li><p><strong>conf_file</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Path to the config file overriding the default settings</p></li>
<li><p><strong>root_dir</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Directory to prepend to paths, defaults to /</p></li>
<li><p><strong>test_config</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.7)"><em>bool</em></a>) -- Set to True to skip reading conf_file</p></li>
<codeclass="descclassname">pylorax.api.config.</code><codeclass="descname">make_dnf_dirs</code><spanclass="sig-paren">(</span><em>conf</em>, <em>uid</em>, <em>gid</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/config.html#make_dnf_dirs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.config.make_dnf_dirs"title="Permalink to this definition">¶</a></dt>
<dd><p>Make any missing dnf directories owned by user:group</p>
<li><p><strong>conf</strong> (<aclass="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>uid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)"><em>int</em></a>) -- uid of owner</p></li>
<li><p><strong>gid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)"><em>int</em></a>) -- gid of owner</p></li>
<codeclass="descclassname">pylorax.api.config.</code><codeclass="descname">make_owned_dir</code><spanclass="sig-paren">(</span><em>p_dir</em>, <em>uid</em>, <em>gid</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/config.html#make_owned_dir"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.config.make_owned_dir"title="Permalink to this definition">¶</a></dt>
<dd><p>Make a directory and its parents, setting owner and group</p>
<codeclass="descclassname">pylorax.api.config.</code><codeclass="descname">make_queue_dirs</code><spanclass="sig-paren">(</span><em>conf</em>, <em>gid</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/config.html#make_queue_dirs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.config.make_queue_dirs"title="Permalink to this definition">¶</a></dt>
<li><p><strong>conf</strong> (<aclass="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> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)"><em>int</em></a>) -- Group ID that has access to the queue directories</p></li>
<spanid="pylorax-api-crossdomain-module"></span><h2>pylorax.api.crossdomain module<aclass="headerlink"href="#module-pylorax.api.crossdomain"title="Permalink to this headline">¶</a></h2>
<dlclass="function">
<dtid="pylorax.api.crossdomain.crossdomain">
<codeclass="descclassname">pylorax.api.crossdomain.</code><codeclass="descname">crossdomain</code><spanclass="sig-paren">(</span><em>origin</em>, <em>methods=None</em>, <em>headers=None</em>, <em>max_age=21600</em>, <em>attach_to_all=True</em>, <em>automatic_options=True</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/crossdomain.html#crossdomain"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.crossdomain.crossdomain"title="Permalink to this definition">¶</a></dt>
<spanid="pylorax-api-dnfbase-module"></span><h2>pylorax.api.dnfbase module<aclass="headerlink"href="#module-pylorax.api.dnfbase"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">pylorax.api.dnfbase.</code><codeclass="descname">DNFLock</code><spanclass="sig-paren">(</span><em>conf</em>, <em>expire_secs=21600</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/dnfbase.html#DNFLock"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.dnfbase.DNFLock"title="Permalink to this definition">¶</a></dt>
<p>Hold the dnf.Base object and a Lock to control access to it.</p>
<p>self.dbo is a property that returns the dnf.Base object, but it <em>may</em> change
from one call to the next if the upstream repositories have changed.</p>
<dlclass="attribute">
<dtid="pylorax.api.dnfbase.DNFLock.lock">
<codeclass="descname">lock</code><aclass="headerlink"href="#pylorax.api.dnfbase.DNFLock.lock"title="Permalink to this definition">¶</a></dt>
<dd><p>Check for repo updates (using expiration time) and return the lock</p>
<p>If the repository has been updated, tear down the old dnf.Base and
create a new one. This is the only way to force dnf to use the new
metadata.</p>
</dd></dl>
<dlclass="attribute">
<dtid="pylorax.api.dnfbase.DNFLock.lock_check">
<codeclass="descname">lock_check</code><aclass="headerlink"href="#pylorax.api.dnfbase.DNFLock.lock_check"title="Permalink to this definition">¶</a></dt>
<dd><p>Force a check for repo updates and return the lock</p>
<p>Use this method sparingly, it removes the repodata and downloads a new copy every time.</p>
<codeclass="descclassname">pylorax.api.dnfbase.</code><codeclass="descname">get_base_object</code><spanclass="sig-paren">(</span><em>conf</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/dnfbase.html#get_base_object"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.dnfbase.get_base_object"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the DNF object with settings from the config file</p>
<spanid="pylorax-api-errors-module"></span><h2>pylorax.api.errors module<aclass="headerlink"href="#module-pylorax.api.errors"title="Permalink to this headline">¶</a></h2>
<spanid="pylorax-api-gitrpm-module"></span><h2>pylorax.api.gitrpm module<aclass="headerlink"href="#module-pylorax.api.gitrpm"title="Permalink to this headline">¶</a></h2>
<p>Clone a git repository and package it as an rpm</p>
<p>This module contains functions for cloning a git repo, creating a tar archive of
the selected commit, branch, or tag, and packaging the files into an rpm that will
be installed by anaconda when creating the image.</p>
<dlclass="class">
<dtid="pylorax.api.gitrpm.GitArchiveTarball">
<emclass="property">class </em><codeclass="descclassname">pylorax.api.gitrpm.</code><codeclass="descname">GitArchiveTarball</code><spanclass="sig-paren">(</span><em>gitRepo</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/gitrpm.html#GitArchiveTarball"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.gitrpm.GitArchiveTarball"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">write_file</code><spanclass="sig-paren">(</span><em>sourcesDir</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/gitrpm.html#GitArchiveTarball.write_file"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.gitrpm.GitArchiveTarball.write_file"title="Permalink to this definition">¶</a></dt>
<dd><p>Create the tar archive</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>sourcesDir</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Path to use for creating the archive</p>
</dd>
</dl>
<p>This clones the git repository and creates a git archive from the specified reference.
The result is in RPMNAME.tar.xz under the sourcesDir</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="pylorax.api.gitrpm.GitRpmBuild">
<emclass="property">class </em><codeclass="descclassname">pylorax.api.gitrpm.</code><codeclass="descname">GitRpmBuild</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/gitrpm.html#GitRpmBuild"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.gitrpm.GitRpmBuild"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">add_git_tarball</code><spanclass="sig-paren">(</span><em>gitRepo</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/gitrpm.html#GitRpmBuild.add_git_tarball"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.gitrpm.GitRpmBuild.add_git_tarball"title="Permalink to this definition">¶</a></dt>
<dd><p>Add a tar archive of a git repository to the rpm</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>gitRepo</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)"><em>dict</em></a>) -- A dict with the repository details</p>
</dd>
</dl>
<p>This populates the rpm with the URL of the git repository, the summary
describing the repo, the description of the repository and reference used,
and sets up the rpm to install the archive contents into the destination
path.</p>
</dd></dl>
<dlclass="method">
<dtid="pylorax.api.gitrpm.GitRpmBuild.check">
<codeclass="descname">check</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/gitrpm.html#GitRpmBuild.check"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.gitrpm.GitRpmBuild.check"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="pylorax.api.gitrpm.GitRpmBuild.clean">
<codeclass="descname">clean</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/gitrpm.html#GitRpmBuild.clean"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.gitrpm.GitRpmBuild.clean"title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the base directory from inside the tmpdir</p>
<codeclass="descname">cleanup_tmpdir</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/gitrpm.html#GitRpmBuild.cleanup_tmpdir"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.gitrpm.GitRpmBuild.cleanup_tmpdir"title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the temporary directory and all of its contents</p>
<codeclass="descname">get_base_dir</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/gitrpm.html#GitRpmBuild.get_base_dir"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.gitrpm.GitRpmBuild.get_base_dir"title="Permalink to this definition">¶</a></dt>
<dd><p>Place all the files under a temporary directory + rpmbuild/</p>
</dd></dl>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.gitrpm.create_gitrpm_repo">
<codeclass="descclassname">pylorax.api.gitrpm.</code><codeclass="descname">create_gitrpm_repo</code><spanclass="sig-paren">(</span><em>results_dir</em>, <em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/gitrpm.html#create_gitrpm_repo"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.gitrpm.create_gitrpm_repo"title="Permalink to this definition">¶</a></dt>
<dd><p>Create a dnf repository with the rpms from the recipe</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>results_dir</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Path to create the repository under</p></li>
<li><p><strong>recipe</strong> (<aclass="reference internal"href="#pylorax.api.recipes.Recipe"title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) -- The recipe to get the repos.git entries from</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>Path to the dnf repository or ""</p>
<p>This function creates a dnf repository directory at results_dir+"repo/",
creates rpms for all of the repos.git entries in the recipe, runs createrepo_c
on the dnf repository so that Anaconda can use it, and returns the path to the
repository to the caller.</p>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.gitrpm.get_repo_description">
<codeclass="descclassname">pylorax.api.gitrpm.</code><codeclass="descname">get_repo_description</code><spanclass="sig-paren">(</span><em>gitRepo</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/gitrpm.html#get_repo_description"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.gitrpm.get_repo_description"title="Permalink to this definition">¶</a></dt>
<dd><p>Return a description including the git repo and reference</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>gitRepo</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)"><em>dict</em></a>) -- A dict with the repository details</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>A string with the git repo url and reference</p>
<codeclass="descclassname">pylorax.api.gitrpm.</code><codeclass="descname">make_git_rpm</code><spanclass="sig-paren">(</span><em>gitRepo</em>, <em>dest</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/gitrpm.html#make_git_rpm"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.gitrpm.make_git_rpm"title="Permalink to this definition">¶</a></dt>
<dd><p>Create an rpm from the specified git repo</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>gitRepo</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)"><em>dict</em></a>) -- A dict with the repository details</p>
</dd>
</dl>
<p>This will clone the git repository, create an archive of the selected reference,
and build an rpm that will install the files from the repository under the destination
directory. The gitRepo dict should have the following fields:</p>
<spanid="pylorax-api-projects-module"></span><h2>pylorax.api.projects module<aclass="headerlink"href="#module-pylorax.api.projects"title="Permalink to this headline">¶</a></h2>
<dlclass="exception">
<dtid="pylorax.api.projects.ProjectsError">
<emclass="property">exception </em><codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">ProjectsError</code><aclass="reference internal"href="_modules/pylorax/api/projects.html#ProjectsError"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.projects.ProjectsError"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">api_changelog</code><spanclass="sig-paren">(</span><em>changelog</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#api_changelog"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.projects.api_changelog"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>changelog</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#tuple"title="(in Python v3.7)"><em>tuple</em></a>) -- A list of time, author, string tuples.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The most recent changelog text or ""</p>
<p>This returns only the most recent changelog entry.</p>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.projects.api_time">
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">api_time</code><spanclass="sig-paren">(</span><em>t</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#api_time"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.projects.api_time"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">delete_repo_source</code><spanclass="sig-paren">(</span><em>source_glob</em>, <em>source_name</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#delete_repo_source"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.projects.delete_repo_source"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>source_glob</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- A glob of the repo sources to search</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>None</p>
</dd>
<dtclass="field-odd">Raises</dt>
<ddclass="field-odd"><p>ProjectsError if there was a problem</p>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">dep_evra</code><spanclass="sig-paren">(</span><em>dep</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#dep_evra"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">dep_nevra</code><spanclass="sig-paren">(</span><em>dep</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#dep_nevra"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.projects.dep_nevra"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the name-epoch:version-release.arch</p>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">dnf_repo_to_file_repo</code><spanclass="sig-paren">(</span><em>repo</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#dnf_repo_to_file_repo"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">estimate_size</code><spanclass="sig-paren">(</span><em>packages</em>, <em>block_size=6144</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#estimate_size"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<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> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)"><em>int</em></a>) -- The block size to use for rounding up file sizes.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The estimated size of installed packages</p>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">get_repo_sources</code><spanclass="sig-paren">(</span><em>source_glob</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#get_repo_sources"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<ddclass="field-odd"><p><strong>source_glob</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- A glob to use to match the source files, including full path</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>A list of the source ids in all of the matching files</p>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">get_source_ids</code><spanclass="sig-paren">(</span><em>source_path</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#get_source_ids"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<ddclass="field-odd"><p><strong>source_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Full path and filename of the source (yum repo) file</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>A list of source id strings</p>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">modules_info</code><spanclass="sig-paren">(</span><em>dbo</em>, <em>module_names</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#modules_info"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.projects.modules_info"title="Permalink to this definition">¶</a></dt>
<dd><p>Return details about a module, including dependencies</p>
<li><p><strong>dbo</strong> (<em>dnf.Base</em>) -- dnf base object</p></li>
<li><p><strong>module_names</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Names of the modules to get info about</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>List of dicts with module details and dependencies.</p>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">modules_list</code><spanclass="sig-paren">(</span><em>dbo</em>, <em>module_names</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#modules_list"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.projects.modules_list"title="Permalink to this definition">¶</a></dt>
<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> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)"><em>int</em></a>) -- Maximum number of modules to return</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>List of module information and total count</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="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>
<dlclass="function">
<dtid="pylorax.api.projects.pkg_to_build">
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">pkg_to_build</code><spanclass="sig-paren">(</span><em>pkg</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#pkg_to_build"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>pkg</strong> (<em>hawkey.Package</em>) -- hawkey.Package object with package details</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>A dict with the build details, epoch, release, arch, build_time, changelog, ...</p>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">pkg_to_dep</code><spanclass="sig-paren">(</span><em>pkg</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#pkg_to_dep"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">pkg_to_project</code><spanclass="sig-paren">(</span><em>pkg</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#pkg_to_project"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">pkg_to_project_info</code><spanclass="sig-paren">(</span><em>pkg</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#pkg_to_project_info"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">proj_to_module</code><spanclass="sig-paren">(</span><em>proj</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#proj_to_module"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">projects_depsolve</code><spanclass="sig-paren">(</span><em>dbo</em>, <em>projects</em>, <em>groups</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#projects_depsolve"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.projects.projects_depsolve"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">projects_depsolve_with_size</code><spanclass="sig-paren">(</span><em>dbo</em>, <em>projects</em>, <em>groups</em>, <em>with_core=True</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#projects_depsolve_with_size"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.projects.projects_depsolve_with_size"title="Permalink to this definition">¶</a></dt>
<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>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>installed size and a list of NEVRA's of the project and its dependencies</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p>tuple of (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)">int</a>, list of dicts)</p>
</dd>
<dtclass="field-even">Raises</dt>
<ddclass="field-even"><p>ProjectsError if there was a problem installing something</p>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">projects_info</code><spanclass="sig-paren">(</span><em>dbo</em>, <em>project_names</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#projects_info"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.projects.projects_info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>dbo</strong> (<em>dnf.Base</em>) -- dnf base object</p></li>
<li><p><strong>project_names</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- List of names of projects to get info about</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>List of project info dicts with pkg_to_project as well as epoch, version, release, etc.</p>
<p>If project_names is None it will return the full list of available packages</p>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.projects.projects_list">
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">projects_list</code><spanclass="sig-paren">(</span><em>dbo</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#projects_list"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.projects.projects_list"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">repo_to_source</code><spanclass="sig-paren">(</span><em>repo</em>, <em>system_source</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#repo_to_source"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>system_source</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.7)"><em>bool</em></a>) -- True if this source is an immutable system source</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>A dict with Weldr Source fields filled in</p>
<codeclass="descclassname">pylorax.api.projects.</code><codeclass="descname">source_to_repo</code><spanclass="sig-paren">(</span><em>source</em>, <em>dnf_conf</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/projects.html#source_to_repo"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<spanid="pylorax-api-queue-module"></span><h2>pylorax.api.queue module<aclass="headerlink"href="#module-pylorax.api.queue"title="Permalink to this headline">¶</a></h2>
<p>Functions to monitor compose queue and run anaconda</p>
<dlclass="function">
<dtid="pylorax.api.queue.build_status">
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">build_status</code><spanclass="sig-paren">(</span><em>cfg</em>, <em>status_filter=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#build_status"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>status_filter</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- What builds to return. None == all, "FINISHED", or "FAILED"</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>A list of the build details (from compose_details)</p>
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">check_queues</code><spanclass="sig-paren">(</span><em>cfg</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#check_queues"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">compose_detail</code><spanclass="sig-paren">(</span><em>results_dir</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#compose_detail"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.queue.compose_detail"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>results_dir</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The directory containing the metadata and results for the build</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>A dictionary with details about the compose</p>
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">get_compose_type</code><spanclass="sig-paren">(</span><em>results_dir</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#get_compose_type"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.queue.get_compose_type"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>results_dir</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The directory containing the metadata and results for the build</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The type of compose (eg. 'tar')</p>
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">get_image_name</code><spanclass="sig-paren">(</span><em>uuid_dir</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#get_image_name"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>uuid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The UUID of the build</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The image filename and full path</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p>tuple of strings</p>
</dd>
<dtclass="field-even">Raises</dt>
<ddclass="field-even"><p>RuntimeError if there was a problem (eg. invalid uuid, missing config file)</p>
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">make_compose</code><spanclass="sig-paren">(</span><em>cfg</em>, <em>results_dir</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#make_compose"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>results_dir</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The directory containing the metadata and results for the build</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>Nothing</p>
</dd>
<dtclass="field-odd">Raises</dt>
<ddclass="field-odd"><p>May raise various exceptions</p>
<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>
<dlclass="function">
<dtid="pylorax.api.queue.monitor">
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">monitor</code><spanclass="sig-paren">(</span><em>cfg</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#monitor"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.queue.monitor"title="Permalink to this definition">¶</a></dt>
<dd><p>Monitor the queue for new compose requests</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>
<dlclass="function">
<dtid="pylorax.api.queue.queue_status">
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">queue_status</code><spanclass="sig-paren">(</span><em>cfg</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#queue_status"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">start_queue_monitor</code><spanclass="sig-paren">(</span><em>cfg</em>, <em>uid</em>, <em>gid</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#start_queue_monitor"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>uid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)"><em>int</em></a>) -- User ID that owns the queue</p></li>
<li><p><strong>gid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)"><em>int</em></a>) -- Group ID that owns the queue</p></li>
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">uuid_cancel</code><spanclass="sig-paren">(</span><em>cfg</em>, <em>uuid</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#uuid_cancel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.queue.uuid_cancel"title="Permalink to this definition">¶</a></dt>
<li><p><strong>uuid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The UUID of the build</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>True if it was canceled and deleted</p>
<p>Only call this if the build status is WAITING or RUNNING</p>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.queue.uuid_delete">
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">uuid_delete</code><spanclass="sig-paren">(</span><em>cfg</em>, <em>uuid</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#uuid_delete"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>uuid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The UUID of the build</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>True if it was deleted</p>
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">uuid_image</code><spanclass="sig-paren">(</span><em>cfg</em>, <em>uuid</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#uuid_image"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.queue.uuid_image"title="Permalink to this definition">¶</a></dt>
<li><p><strong>uuid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The UUID of the build</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The image filename and full path</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p>tuple of strings</p>
</dd>
<dtclass="field-even">Raises</dt>
<ddclass="field-even"><p>RuntimeError if there was a problem (eg. invalid uuid, missing config file)</p>
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">uuid_info</code><spanclass="sig-paren">(</span><em>cfg</em>, <em>uuid</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#uuid_info"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.queue.uuid_info"title="Permalink to this definition">¶</a></dt>
<dd><p>Return information about the composition</p>
<li><p><strong>uuid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The UUID of the build</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>dictionary of information about the composition or None</p>
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">uuid_log</code><spanclass="sig-paren">(</span><em>cfg</em>, <em>uuid</em>, <em>size=1024</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#uuid_log"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>uuid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The UUID of the build</p></li>
<li><p><strong>size</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)"><em>int</em></a>) -- Number of kbytes to read. Default is 1024</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>Up to <cite>size</cite> kbytes from the end of the log</p>
<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>
<dlclass="function">
<dtid="pylorax.api.queue.uuid_status">
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">uuid_status</code><spanclass="sig-paren">(</span><em>cfg</em>, <em>uuid</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#uuid_status"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>uuid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The UUID of the build</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>Details about the build</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p><aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)">dict</a> or <aclass="reference external"href="https://docs.python.org/3/library/constants.html#None"title="(in Python v3.7)">None</a></p>
<p>Returns the same dict as <cite>compose_details()</cite></p>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.queue.uuid_tar">
<codeclass="descclassname">pylorax.api.queue.</code><codeclass="descname">uuid_tar</code><spanclass="sig-paren">(</span><em>cfg</em>, <em>uuid</em>, <em>metadata=False</em>, <em>image=False</em>, <em>logs=False</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/queue.html#uuid_tar"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.queue.uuid_tar"title="Permalink to this definition">¶</a></dt>
<li><p><strong>uuid</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The UUID of the build</p></li>
<li><p><strong>metadata</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.7)"><em>bool</em></a>) -- Set to true to include all the metadata needed to reproduce the build</p></li>
<li><p><strong>image</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.7)"><em>bool</em></a>) -- Set to true to include the output image</p></li>
<li><p><strong>logs</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.7)"><em>bool</em></a>) -- Set to true to include the logs from the build</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>A stream of bytes from tar</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p>A generator</p>
</dd>
<dtclass="field-even">Raises</dt>
<ddclass="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
<spanid="pylorax-api-recipes-module"></span><h2>pylorax.api.recipes module<aclass="headerlink"href="#module-pylorax.api.recipes"title="Permalink to this headline">¶</a></h2>
<dlclass="class">
<dtid="pylorax.api.recipes.CommitDetails">
<emclass="property">class </em><codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">CommitDetails</code><spanclass="sig-paren">(</span><em>commit</em>, <em>timestamp</em>, <em>message</em>, <em>revision=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#CommitDetails"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.CommitDetails"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">CommitTimeValError</code><aclass="reference internal"href="_modules/pylorax/api/recipes.html#CommitTimeValError"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.CommitTimeValError"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">NewRecipeGit</code><spanclass="sig-paren">(</span><em>toml_dict</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#NewRecipeGit"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>rpmname</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><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> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Version of the rpm, eg. "1.0.0"</p></li>
<li><p><strong>rpmrelease</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Release of the rpm, eg. "1"</p></li>
<li><p><strong>summary</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Summary string for the rpm</p></li>
<li><p><strong>repo</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- URL of the get repo to clone and create the archive from</p></li>
<li><p><strong>ref</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><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> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Path to install the / of the git repo at when installing the rpm</p></li>
and a .toml() function to return the recipe as a TOML string.</p>
<dlclass="method">
<dtid="pylorax.api.recipes.Recipe.bump_version">
<codeclass="descname">bump_version</code><spanclass="sig-paren">(</span><em>old_version=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#Recipe.bump_version"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.Recipe.bump_version"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>old_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- An optional old version number</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The new version number or None</p>
<codeclass="descname">freeze</code><spanclass="sig-paren">(</span><em>deps</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#Recipe.freeze"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<ddclass="field-odd"><p><strong>deps</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#list"title="(in Python v3.7)"><em>list</em></a><em>(</em>) -- A list of dependency NEVRA to use to fill in the modules and packages</p>
<codeclass="descname">group_names</code><aclass="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>
<codeclass="descname">module_names</code><aclass="headerlink"href="#pylorax.api.recipes.Recipe.module_names"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">module_nver</code><aclass="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>
<codeclass="descname">package_names</code><aclass="headerlink"href="#pylorax.api.recipes.Recipe.package_names"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">package_nver</code><aclass="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>
<codeclass="descname">toml</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#Recipe.toml"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="exception">
<dtid="pylorax.api.recipes.RecipeError">
<emclass="property">exception </em><codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">RecipeError</code><aclass="reference internal"href="_modules/pylorax/api/recipes.html#RecipeError"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.RecipeError"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">RecipeFileError</code><aclass="reference internal"href="_modules/pylorax/api/recipes.html#RecipeFileError"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.RecipeFileError"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">RecipeGroup</code><spanclass="sig-paren">(</span><em>name</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#RecipeGroup"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.RecipeGroup"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">RecipeModule</code><spanclass="sig-paren">(</span><em>name</em>, <em>version</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#RecipeModule"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.RecipeModule"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">RecipePackage</code><spanclass="sig-paren">(</span><em>name</em>, <em>version</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#RecipePackage"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.RecipePackage"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">commit_recipe</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#commit_recipe"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.commit_recipe"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">commit_recipe_directory</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>directory</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#commit_recipe_directory"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.commit_recipe_directory"title="Permalink to this definition">¶</a></dt>
<li><p><strong>directory</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The directory of *.toml recipes to commit</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>None</p>
</dd>
<dtclass="field-odd">Raises</dt>
<ddclass="field-odd"><p>Can raise errors from Ggit or RecipeFileError</p>
<p>Files with Toml or RecipeFileErrors will be skipped, and the remainder will
be tried.</p>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.recipes.commit_recipe_file">
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">commit_recipe_file</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#commit_recipe_file"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.commit_recipe_file"title="Permalink to this definition">¶</a></dt>
<li><p><strong>filename</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Path to the recipe file to commit</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>OId of the new commit</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p>Git.OId</p>
</dd>
<dtclass="field-even">Raises</dt>
<ddclass="field-even"><p>Can raise errors from Ggit or RecipeFileError</p>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">delete_file</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#delete_file"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.delete_file"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">delete_recipe</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#delete_recipe"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.delete_recipe"title="Permalink to this definition">¶</a></dt>
<li><p><strong>recipe_name</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Recipe name to delete</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>OId of the new commit</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p>Git.OId</p>
</dd>
<dtclass="field-even">Raises</dt>
<ddclass="field-even"><p>Can raise errors from Ggit</p>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">diff_items</code><spanclass="sig-paren">(</span><em>title</em>, <em>old_items</em>, <em>new_items</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#diff_items"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.diff_items"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the differences between two lists of dicts.</p>
<li><p><strong>title</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Title of the entry</p></li>
<li><p><strong>old_items</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#list"title="(in Python v3.7)"><em>list</em></a><em>(</em><aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)"><em>dict</em></a><em>)</em>) -- List of item dicts with "name" field</p></li>
<li><p><strong>new_items</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#list"title="(in Python v3.7)"><em>list</em></a><em>(</em><aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)"><em>dict</em></a><em>)</em>) -- List of item dicts with "name" field</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>List of diff dicts with old/new entries</p>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">find_commit_tag</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em>, <em>commit_id</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#find_commit_tag"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">find_name</code><spanclass="sig-paren">(</span><em>name</em>, <em>lst</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#find_name"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>name</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Name to search for</p></li>
<li><p><strong>lst</strong> -- List of dict's with "name" field</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>First dict with matching name, or None</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p><aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)">dict</a> or <aclass="reference external"href="https://docs.python.org/3/library/constants.html#None"title="(in Python v3.7)">None</a></p>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">get_commit_details</code><spanclass="sig-paren">(</span><em>commit</em>, <em>revision=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#get_commit_details"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">get_revision_from_tag</code><spanclass="sig-paren">(</span><em>tag</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#get_revision_from_tag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.get_revision_from_tag"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>tag</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The tag to exract the revision from</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The integer revision or None</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p><aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)">int</a> or <aclass="reference external"href="https://docs.python.org/3/library/constants.html#None"title="(in Python v3.7)">None</a></p>
</dd>
</dl>
<p>The revision is the part after the r in 'branch/filename/rXXX'</p>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">gfile</code><spanclass="sig-paren">(</span><em>path</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#gfile"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="function">
<dtid="pylorax.api.recipes.head_commit">
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">head_commit</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#head_commit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.head_commit"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">is_commit_tag</code><spanclass="sig-paren">(</span><em>repo</em>, <em>commit_id</em>, <em>tag</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#is_commit_tag"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<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> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The tag to check</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>True if the tag points to the commit, False otherwise</p>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">is_parent_diff</code><spanclass="sig-paren">(</span><em>repo</em>, <em>filename</em>, <em>tree</em>, <em>parent</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#is_parent_diff"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">list_branch_files</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#list_branch_files"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">list_commit_files</code><spanclass="sig-paren">(</span><em>repo</em>, <em>commit</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#list_commit_files"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">list_commits</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em>, <em>limit=0</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#list_commits"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>filename</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- filename to revert</p></li>
<li><p><strong>limit</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)"><em>int</em></a>) -- Number of commits to return (0=all)</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>A list of commit details</p>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">open_or_create_repo</code><spanclass="sig-paren">(</span><em>path</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#open_or_create_repo"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<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>
<dlclass="function">
<dtid="pylorax.api.recipes.prepare_commit">
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">prepare_commit</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>builder</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#prepare_commit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.prepare_commit"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">read_commit</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em>, <em>commit=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#read_commit"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<p>If no commit is passed the master:filename is returned, otherwise it will be
commit:filename</p>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.recipes.read_commit_spec">
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">read_commit_spec</code><spanclass="sig-paren">(</span><em>repo</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#read_commit_spec"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">read_recipe_and_id</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em>, <em>commit=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#read_recipe_and_id"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>recipe_name</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Recipe name to read</p></li>
<p>If no commit is passed the master:filename is returned, otherwise it will be
commit:filename</p>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.recipes.read_recipe_commit">
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">read_recipe_commit</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em>, <em>commit=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#read_recipe_commit"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>recipe_name</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Recipe name to read</p></li>
<p>If no commit is passed the master:filename is returned, otherwise it will be
commit:filename</p>
</dd></dl>
<dlclass="function">
<dtid="pylorax.api.recipes.recipe_diff">
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">recipe_diff</code><spanclass="sig-paren">(</span><em>old_recipe</em>, <em>new_recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#recipe_diff"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.recipe_diff"title="Permalink to this definition">¶</a></dt>
<li><p><strong>old_recipe</strong> (<aclass="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> (<aclass="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>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>A list of diff dict entries with old/new</p>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">recipe_filename</code><spanclass="sig-paren">(</span><em>name</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#recipe_filename"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.recipe_filename"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">recipe_from_dict</code><spanclass="sig-paren">(</span><em>recipe_dict</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#recipe_from_dict"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<ddclass="field-odd"><p><strong>recipe_dict</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.7)"><em>dict</em></a>) -- A plain dict of the recipe</p>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">recipe_from_file</code><spanclass="sig-paren">(</span><em>recipe_path</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#recipe_from_file"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">recipe_from_toml</code><spanclass="sig-paren">(</span><em>recipe_str</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#recipe_from_toml"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">repo_file_exists</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#repo_file_exists"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>repo</strong> (<em>Git.Repository</em>) -- Open repository</p></li>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">revert_file</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em>, <em>commit</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#revert_file"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">revert_recipe</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em>, <em>commit</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#revert_recipe"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>recipe_name</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Recipe name to revert</p></li>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">tag_file_commit</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#tag_file_commit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.tag_file_commit"title="Permalink to this definition">¶</a></dt>
<p>This uses git tags, of the form <cite>refs/tags/<branch>/<filename>/r<revision></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>
<dlclass="function">
<dtid="pylorax.api.recipes.tag_recipe_commit">
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">tag_recipe_commit</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#tag_recipe_commit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.tag_recipe_commit"title="Permalink to this definition">¶</a></dt>
<li><p><strong>recipe_name</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Recipe name to tag</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>Tag id or None if it failed.</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p>Git.OId</p>
</dd>
<dtclass="field-even">Raises</dt>
<ddclass="field-even"><p>Can raise errors from Ggit</p>
<codeclass="descclassname">pylorax.api.recipes.</code><codeclass="descname">write_commit</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em>, <em>message</em>, <em>content</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/recipes.html#write_commit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.recipes.write_commit"title="Permalink to this definition">¶</a></dt>
<li><p><strong>filename</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- full path of the file to add</p></li>
<li><p><strong>message</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The commit message</p></li>
<li><p><strong>content</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The data to write</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>OId of the new commit</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p>Git.OId</p>
</dd>
<dtclass="field-even">Raises</dt>
<ddclass="field-even"><p>Can raise errors from Ggit</p>
<spanid="pylorax-api-regexes-module"></span><h2>pylorax.api.regexes module<aclass="headerlink"href="#module-pylorax.api.regexes"title="Permalink to this headline">¶</a></h2>
<spanid="pylorax-api-server-module"></span><h2>pylorax.api.server module<aclass="headerlink"href="#module-pylorax.api.server"title="Permalink to this headline">¶</a></h2>
<dlclass="class">
<dtid="pylorax.api.server.GitLock">
<emclass="property">class </em><codeclass="descclassname">pylorax.api.server.</code><codeclass="descname">GitLock</code><spanclass="sig-paren">(</span><em>repo</em>, <em>lock</em>, <em>dir</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pylorax.api.server.GitLock"title="Permalink to this definition">¶</a></dt>
<spanid="pylorax-api-timestamp-module"></span><h2>pylorax.api.timestamp module<aclass="headerlink"href="#module-pylorax.api.timestamp"title="Permalink to this headline">¶</a></h2>
<dlclass="function">
<dtid="pylorax.api.timestamp.timestamp_dict">
<codeclass="descclassname">pylorax.api.timestamp.</code><codeclass="descname">timestamp_dict</code><spanclass="sig-paren">(</span><em>destdir</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/timestamp.html#timestamp_dict"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.timestamp.timestamp_dict"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pylorax.api.timestamp.write_timestamp">
<codeclass="descclassname">pylorax.api.timestamp.</code><codeclass="descname">write_timestamp</code><spanclass="sig-paren">(</span><em>destdir</em>, <em>ty</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/timestamp.html#write_timestamp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.timestamp.write_timestamp"title="Permalink to this definition">¶</a></dt>
<spanid="pylorax-api-v0-module"></span><h2>pylorax.api.v0 module<aclass="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>
<divclass="section"id="status-responses">
<h3>Status Responses<aclass="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>
<spanclass="s2">"errors"</span><spanclass="p">:</span><spanclass="p">[</span><spanclass="s2">"ggit-error: Failed to remove entry. File isn't in the tree - jboss.toml (-1)"</span><spanclass="p">]</span>
<h4><cite>/api/v0/blueprints/info/<blueprint_names>[?format=<json|toml>]</cite><aclass="headerlink"href="#api-v0-blueprints-info-blueprint-names-format-json-toml"title="Permalink to this headline">¶</a></h4>
<spanclass="s2">"description"</span><spanclass="p">:</span><spanclass="s2">"An example GlusterFS server with samba"</span><spanclass="p">,</span>
<spanclass="s2">"errors"</span><spanclass="p">:</span><spanclass="p">[</span><spanclass="s2">"ggit-error: the path 'missing.toml' does not exist in the given tree (-3)"</span><spanclass="p">]</span>
<h4><cite>/api/v0/blueprints/changes/<blueprint_names>[?offset=0&limit=20]</cite><aclass="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>
<spanclass="s2">"message"</span><spanclass="p">:</span><spanclass="s2">"blueprint glusterfs, version 0.0.6 saved."</span><spanclass="p">,</span>
<spanclass="s2">"message"</span><spanclass="p">:</span><spanclass="s2">"blueprint glusterfs, version 0.0.5 saved."</span><spanclass="p">,</span>
<spanclass="s2">"message"</span><spanclass="p">:</span><spanclass="s2">"blueprint glusterfs, version 0.0.4 saved."</span><spanclass="p">,</span>
<spanclass="s2">"message"</span><spanclass="p">:</span><spanclass="s2">"blueprint glusterfs, version 0.0.3 saved."</span><spanclass="p">,</span>
<spanclass="s2">"message"</span><spanclass="p">:</span><spanclass="s2">"blueprint glusterfs, version 0.0.2 saved."</span><spanclass="p">,</span>
<spanclass="s2">"message"</span><spanclass="p">:</span><spanclass="s2">"blueprint glusterfs, version 0.0.1 saved."</span><spanclass="p">,</span>
<h4>DELETE <cite>/api/v0/blueprints/delete/<blueprint_name></cite><aclass="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
<h4>POST <cite>/api/v0/blueprints/workspace</cite><aclass="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>
<h4>DELETE <cite>/api/v0/blueprints/workspace/<blueprint_name></cite><aclass="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>
<h4>POST <cite>/api/v0/blueprints/undo/<blueprint_name>/<commit></cite><aclass="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>
<h4>POST <cite>/api/v0/blueprints/tag/<blueprint_name></cite><aclass="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/<branch>/<filename>/r<revision></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>
<h4><cite>/api/v0/blueprints/diff/<blueprint_name>/<from_commit>/<to_commit></cite><aclass="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>
<h4><cite>/api/v0/blueprints/freeze/<blueprint_names></cite><aclass="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>
<spanclass="s2">"description"</span><spanclass="p">:</span><spanclass="s2">"An example GlusterFS server with samba"</span><spanclass="p">,</span>
<h4><cite>/api/v0/blueprints/depsolve/<blueprint_names></cite><aclass="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
<spanclass="s2">"description"</span><spanclass="p">:</span><spanclass="s2">"An example GlusterFS server with samba"</span><spanclass="p">,</span>
<h4><cite>/api/v0/projects/list[?offset=0&limit=20]</cite><aclass="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>
<spanclass="s2">"description"</span><spanclass="p">:</span><spanclass="s2">"0 A.D. (pronounced "</span><spanclass="n">zero</span><spanclass="n">ey</span><spanclass="o">-</span><spanclass="n">dee</span><spanclass="s2">") is a ..."</span><spanclass="p">,</span>
<spanclass="s2">"summary"</span><spanclass="p">:</span><spanclass="s2">"Cross-Platform RTS Game of Ancient Warfare"</span><spanclass="p">,</span>
<h4><cite>/api/v0/projects/info/<project_names></cite><aclass="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>
<spanclass="s2">"description"</span><spanclass="p">:</span><spanclass="s2">"The GNU tar program saves many ..."</span><spanclass="p">,</span>
<spanclass="s2">"summary"</span><spanclass="p">:</span><spanclass="s2">"A GNU file archiving program"</span><spanclass="p">,</span>
<h4><cite>/api/v0/projects/depsolve/<project_names></cite><aclass="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
<h4><cite>/api/v0/projects/source/info/<source-names></cite><aclass="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
<h4>POST <cite>/api/v0/projects/source/new</cite><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">proxy</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">gpgkey_urls</span></code> entries are optional. All of the others are required. The supported
<p>If <codeclass="docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">check_gpg</span></code> is true the GPG key must either be installed on the host system, or <codeclass="docutils literal notranslate"><spanclass="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>
<h4>DELETE <cite>/api/v0/projects/source/delete/<source-name></cite><aclass="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>
<h4><cite>/api/v0/modules/list[?offset=0&limit=20]</cite><aclass="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
<h4><cite>/api/v0/modules/list/<module_names>[?offset=0&limit=20]</cite><aclass="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>
<h4><cite>/api/v0/modules/info/<module_names></cite><aclass="headerlink"href="#api-v0-modules-info-module-names"title="Permalink to this headline">¶</a></h4>
<spanclass="s2">"description"</span><spanclass="p">:</span><spanclass="s2">"The GNU tar program saves ..."</span><spanclass="p">,</span>
<spanclass="s2">"summary"</span><spanclass="p">:</span><spanclass="s2">"A GNU file archiving program"</span><spanclass="p">,</span>
<h4><cite>/api/v0/compose/status/<uuids>[?blueprint=<blueprint_name>&status=<compose_status>&type=<compose_type>]</cite><aclass="headerlink"href="#api-v0-compose-status-uuids-blueprint-blueprint-name-status-compose-status-type-compose-type"title="Permalink to this headline">¶</a></h4>
<h4>DELETE <cite>/api/v0/compose/cancel/<uuid></cite><aclass="headerlink"href="#delete-api-v0-compose-cancel-uuid"title="Permalink to this headline">¶</a></h4>
<h4>DELETE <cite>/api/v0/compose/delete/<uuids></cite><aclass="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>
<spanclass="s2">"description"</span><spanclass="p">:</span><spanclass="s2">"An example kubernetes master"</span><spanclass="p">,</span>
<h4><cite>/api/v0/compose/metadata/<uuid></cite><aclass="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
<h4><cite>/api/v0/compose/results/<uuid></cite><aclass="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>
<h4><cite>/api/v0/compose/log/<uuid>[?size=kbytes]</cite><aclass="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
<codeclass="descclassname">pylorax.api.v0.</code><codeclass="descname">blueprint_exists</code><spanclass="sig-paren">(</span><em>api</em>, <em>branch</em>, <em>blueprint_name</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/v0.html#blueprint_exists"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.v0.blueprint_exists"title="Permalink to this definition">¶</a></dt>
<li><p><strong>recipe_name</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- Recipe name to read</p></li>
<codeclass="descclassname">pylorax.api.v0.</code><codeclass="descname">take_limits</code><spanclass="sig-paren">(</span><em>iterable</em>, <em>offset</em>, <em>limit</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/v0.html#take_limits"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<li><p><strong>iterable</strong> (<em>iter</em>) -- The object to limit</p></li>
<li><p><strong>offset</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)"><em>int</em></a>) -- The number of items to skip</p></li>
<li><p><strong>limit</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.7)"><em>int</em></a>) -- The total number of items to return</p></li>
<codeclass="descclassname">pylorax.api.v0.</code><codeclass="descname">v0_api</code><spanclass="sig-paren">(</span><em>api</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/v0.html#v0_api"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.v0.v0_api"title="Permalink to this definition">¶</a></dt>
<spanid="pylorax-api-workspace-module"></span><h2>pylorax.api.workspace module<aclass="headerlink"href="#module-pylorax.api.workspace"title="Permalink to this headline">¶</a></h2>
<dlclass="function">
<dtid="pylorax.api.workspace.workspace_delete">
<codeclass="descclassname">pylorax.api.workspace.</code><codeclass="descname">workspace_delete</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/workspace.html#workspace_delete"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.workspace.workspace_delete"title="Permalink to this definition">¶</a></dt>
<li><p><strong>recipe_name</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The name of the recipe</p></li>
<codeclass="descclassname">pylorax.api.workspace.</code><codeclass="descname">workspace_dir</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/workspace.html#workspace_dir"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.workspace.workspace_dir"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pylorax.api.workspace.</code><codeclass="descname">workspace_read</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/workspace.html#workspace_read"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.workspace.workspace_read"title="Permalink to this definition">¶</a></dt>
<li><p><strong>recipe_name</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.7)"><em>str</em></a>) -- The name of the recipe</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>The workspace copy of the recipe, or None if it doesn't exist</p>
</dd>
<dtclass="field-odd">Return type</dt>
<ddclass="field-odd"><p><aclass="reference internal"href="#pylorax.api.recipes.Recipe"title="pylorax.api.recipes.Recipe">Recipe</a> or <aclass="reference external"href="https://docs.python.org/3/library/constants.html#None"title="(in Python v3.7)">None</a></p>
<codeclass="descclassname">pylorax.api.workspace.</code><codeclass="descname">workspace_write</code><spanclass="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/workspace.html#workspace_write"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.workspace.workspace_write"title="Permalink to this definition">¶</a></dt>
<li><p><strong>recipe</strong> (<aclass="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>
<spanid="module-contents"></span><h2>Module contents<aclass="headerlink"href="#module-pylorax.api"title="Permalink to this headline">¶</a></h2>
<dlclass="function">
<dtid="pylorax.api.crossdomain">
<codeclass="descclassname">pylorax.api.</code><codeclass="descname">crossdomain</code><spanclass="sig-paren">(</span><em>origin</em>, <em>methods=None</em>, <em>headers=None</em>, <em>max_age=21600</em>, <em>attach_to_all=True</em>, <em>automatic_options=True</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pylorax/api/crossdomain.html#crossdomain"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pylorax.api.crossdomain"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
