<spanid="composer-cli-blueprints-module"></span><h2>composer.cli.blueprints module<aclass="headerlink"href="#module-composer.cli.blueprints"title="Permalink to this headline">¶</a></h2>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_changes</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_changes"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_changes"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_cmd</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">opts</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_cmd"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_delete</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_delete"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_delete"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_depsolve</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_depsolve"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_depsolve"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_diff</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_diff"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_diff"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<dt>blueprints diff <blueprint-name> Display the differences between 2 versions of a blueprint.</dt><dd><p><from-commit> Commit hash or NEWEST
<to-commit> Commit hash, NEWEST, or WORKSPACE</p>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_freeze</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_freeze"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_freeze"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_freeze_save</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_freeze_save"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_freeze_save"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_freeze_show</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_freeze_show"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_freeze_show"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_list</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_list"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_list"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_push</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_push"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_push"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_save</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_save"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_save"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_show</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_show"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_show"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_tag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_tag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_tag"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_undo</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_undo"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_undo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">blueprints_workspace</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#blueprints_workspace"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.blueprints_workspace"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">dict_names</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">lst</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#dict_names"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.dict_names"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">prettyCommitDetails</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">change</span></em>, <emclass="sig-param"><spanclass="n">indent</span><spanclass="o">=</span><spanclass="default_value">4</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#prettyCommitDetails"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.prettyCommitDetails"title="Permalink to this definition">¶</a></dt>
<li><p><strong>indent</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- Number of spaces to indent</p></li>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">pretty_dict</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">d</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#pretty_dict"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.pretty_dict"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">composer.cli.blueprints.</code><codeclass="sig-name descname">pretty_diff_entry</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">diff</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/blueprints.html#pretty_diff_entry"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.pretty_diff_entry"title="Permalink to this definition">¶</a></dt>
<spanid="composer-cli-cmdline-module"></span><h2>composer.cli.cmdline module<aclass="headerlink"href="#module-composer.cli.cmdline"title="Permalink to this headline">¶</a></h2>
<codeclass="sig-prename descclassname">composer.cli.cmdline.</code><codeclass="sig-name descname">composer_cli_parser</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/cmdline.html#composer_cli_parser"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.cmdline.composer_cli_parser"title="Permalink to this definition">¶</a></dt>
<spanid="composer-cli-compose-module"></span><h2>composer.cli.compose module<aclass="headerlink"href="#module-composer.cli.compose"title="Permalink to this headline">¶</a></h2>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<codeclass="sig-prename descclassname">composer.cli.compose.</code><codeclass="sig-name descname">compose_cmd</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">opts</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_cmd"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<codeclass="sig-prename descclassname">composer.cli.compose.</code><codeclass="sig-name descname">compose_ostree</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">testmode</span><spanclass="o">=</span><spanclass="default_value">0</span></em>, <emclass="sig-param"><spanclass="n">api</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_ostree"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_ostree"title="Permalink to this definition">¶</a></dt>
<dd><p>Start a new ostree compose using the selected blueprint and type</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- Set to 1 to simulate a failed compose, set to 2 to simulate a finished one.</p></li>
<li><p><strong>api</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.8)"><em>dict</em></a>) -- Details about the API server, "version" and "backend"</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- Set to 1 to simulate a failed compose, set to 2 to simulate a finished one.</p></li>
<li><p><strong>api</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.8)"><em>dict</em></a>) -- Details about the API server, "version" and "backend"</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<codeclass="sig-prename descclassname">composer.cli.compose.</code><codeclass="sig-name descname">get_parent</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">args</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/compose.html#get_parent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.get_parent"title="Permalink to this definition">¶</a></dt>
<dd><p>Return optional --parent argument, and remaining args</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>args</strong> (<em>list of strings</em>) -- list of arguments</p>
<codeclass="sig-prename descclassname">composer.cli.compose.</code><codeclass="sig-name descname">get_ref</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">args</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/compose.html#get_ref"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.get_ref"title="Permalink to this definition">¶</a></dt>
<dd><p>Return optional --ref argument, and remaining args</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>args</strong> (<em>list of strings</em>) -- list of arguments</p>
<codeclass="sig-prename descclassname">composer.cli.compose.</code><codeclass="sig-name descname">get_size</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">args</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/compose.html#get_size"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.get_size"title="Permalink to this definition">¶</a></dt>
<dd><p>Return optional --size argument, and remaining args</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>args</strong> (<em>list of strings</em>) -- list of arguments</p>
<spanid="composer-cli-help-module"></span><h2>composer.cli.help module<aclass="headerlink"href="#module-composer.cli.help"title="Permalink to this headline">¶</a></h2>
<spanid="composer-cli-modules-module"></span><h2>composer.cli.modules module<aclass="headerlink"href="#module-composer.cli.modules"title="Permalink to this headline">¶</a></h2>
<codeclass="sig-prename descclassname">composer.cli.modules.</code><codeclass="sig-name descname">modules_cmd</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">opts</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/modules.html#modules_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.modules.modules_cmd"title="Permalink to this definition">¶</a></dt>
<spanid="composer-cli-projects-module"></span><h2>composer.cli.projects module<aclass="headerlink"href="#module-composer.cli.projects"title="Permalink to this headline">¶</a></h2>
<codeclass="sig-prename descclassname">composer.cli.projects.</code><codeclass="sig-name descname">projects_cmd</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">opts</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/projects.html#projects_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.projects.projects_cmd"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">composer.cli.projects.</code><codeclass="sig-name descname">projects_info</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/projects.html#projects_info"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.projects.projects_info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.projects.</code><codeclass="sig-name descname">projects_list</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/projects.html#projects_list"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.projects.projects_list"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<spanid="composer-cli-providers-module"></span><h2>composer.cli.providers module<aclass="headerlink"href="#module-composer.cli.providers"title="Permalink to this headline">¶</a></h2>
<codeclass="sig-prename descclassname">composer.cli.providers.</code><codeclass="sig-name descname">providers_cmd</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">opts</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/providers.html#providers_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.providers.providers_cmd"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<dd><p>Add a new provider profile or overwrite an existing one</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<dd><p>Save a provider's profile to a TOML file</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
</ul>
</dd>
</dl>
<p>providers save <provider><profile></p>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
</ul>
</dd>
</dl>
<p>providers show <provider><profile></p>
<dd><p>Return a TOML template for setting the provider's fields</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<spanid="composer-cli-sources-module"></span><h2>composer.cli.sources module<aclass="headerlink"href="#module-composer.cli.sources"title="Permalink to this headline">¶</a></h2>
<codeclass="sig-prename descclassname">composer.cli.sources.</code><codeclass="sig-name descname">sources_add</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/sources.html#sources_add"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.sources.sources_add"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.sources.</code><codeclass="sig-name descname">sources_cmd</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">opts</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/sources.html#sources_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.sources.sources_cmd"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">composer.cli.sources.</code><codeclass="sig-name descname">sources_delete</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/sources.html#sources_delete"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.sources.sources_delete"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.sources.</code><codeclass="sig-name descname">sources_info</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/sources.html#sources_info"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.sources.sources_info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<codeclass="sig-prename descclassname">composer.cli.sources.</code><codeclass="sig-name descname">sources_list</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">socket_path</span></em>, <emclass="sig-param"><spanclass="n">api_version</span></em>, <emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/sources.html#sources_list"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.sources.sources_list"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<spanid="composer-cli-status-module"></span><h2>composer.cli.status module<aclass="headerlink"href="#module-composer.cli.status"title="Permalink to this headline">¶</a></h2>
<codeclass="sig-prename descclassname">composer.cli.status.</code><codeclass="sig-name descname">status_cmd</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">opts</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/status.html#status_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.status.status_cmd"title="Permalink to this definition">¶</a></dt>
<spanid="composer-cli-upload-module"></span><h2>composer.cli.upload module<aclass="headerlink"href="#module-composer.cli.upload"title="Permalink to this headline">¶</a></h2>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<codeclass="sig-prename descclassname">composer.cli.upload.</code><codeclass="sig-name descname">upload_cmd</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">opts</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/upload.html#upload_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.upload.upload_cmd"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete an upload and remove it from the build</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<dd><p>Return detailed information about the upload</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
</ul>
</dd>
</dl>
<p>upload info <uuid></p>
<p>This returns information about the upload, including uuid, name, status, service, and image.</p>
<dd><p>Return the composes and their associated upload uuids and status</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Version of the API to talk to. eg. "0"</p></li>
<li><p><strong>args</strong> (<em>list of str</em>) -- List of remaining arguments from the cmdline</p></li>
<li><p><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#bool"title="(in Python v3.8)"><em>bool</em></a>) -- Set to True to show the JSON output instead of the human readable output</p></li>
<li><p><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.8)"><em>int</em></a>) -- unused in this function</p></li>
<spanid="composer-cli-utilities-module"></span><h2>composer.cli.utilities module<aclass="headerlink"href="#module-composer.cli.utilities"title="Permalink to this headline">¶</a></h2>
<codeclass="sig-prename descclassname">composer.cli.utilities.</code><codeclass="sig-name descname">argify</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">args</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/utilities.html#argify"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.utilities.argify"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">composer.cli.utilities.</code><codeclass="sig-name descname">frozen_toml_filename</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">blueprint_name</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/utilities.html#frozen_toml_filename"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.utilities.frozen_toml_filename"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">composer.cli.utilities.</code><codeclass="sig-name descname">get_arg</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="n">name</span></em>, <emclass="sig-param"><spanclass="n">argtype</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/utilities.html#get_arg"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.utilities.get_arg"title="Permalink to this definition">¶</a></dt>
<dd><p>Return optional value from args, and remaining args</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>args</strong> (<em>list of strings</em>) -- list of arguments</p></li>
<li><p><strong>name</strong> (<em>string</em>) -- The argument to remove from the args list</p></li>
<li><p><strong>argtype</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#type"title="(in Python v3.8)"><em>type</em></a>) -- Type to use for checking the argument value</p></li>
<codeclass="sig-prename descclassname">composer.cli.utilities.</code><codeclass="sig-name descname">handle_api_result</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">result</span></em>, <emclass="sig-param"><spanclass="n">show_json</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/utilities.html#handle_api_result"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.utilities.handle_api_result"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>result</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#dict"title="(in Python v3.8)"><em>dict</em></a>) -- JSON result from the http query</p>
<codeclass="sig-prename descclassname">composer.cli.utilities.</code><codeclass="sig-name descname">packageNEVRA</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">pkg</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/utilities.html#packageNEVRA"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.utilities.packageNEVRA"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">composer.cli.utilities.</code><codeclass="sig-name descname">toml_filename</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">blueprint_name</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/utilities.html#toml_filename"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.utilities.toml_filename"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">composer.cli.</code><codeclass="sig-name descname">main</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">opts</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli.html#main"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.main"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>.
