<h1>cli Package<aclass="headerlink"href="#cli-package"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="id1">
<h2><ttclass="xref py py-mod docutils literal"><spanclass="pre">cli</span></tt> Package<aclass="headerlink"href="#id1"title="Permalink to this headline">¶</a></h2>
<ttclass="descclassname">composer.cli.</tt><ttclass="descname">main</tt><big>(</big><em>opts</em><big>)</big><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>
<spanid="blueprints-module"></span><h2><ttclass="xref py py-mod docutils literal"><spanclass="pre">blueprints</span></tt> Module<aclass="headerlink"href="#module-composer.cli.blueprints"title="Permalink to this headline">¶</a></h2>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_changes</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<dd><p>Display the changes for each of the blueprints</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_cmd</tt><big>(</big><em>opts</em><big>)</big><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>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_delete</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_depsolve</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<dd><p>Display the packages needed to install the blueprint</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_diff</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<dd><p>Display the differences between 2 versions of a blueprint</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_freeze</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_freeze_save</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<dd><p>Save the frozen blueprint to a TOML file</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_freeze_show</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<dd><p>Show the frozen blueprint in TOML format</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_list</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<dd><p>Output the list of available blueprints</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_push</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<dd><p>Push a blueprint TOML file to the server, updating the blueprint</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_save</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_show</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_tag</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<dd><p>Tag the most recent blueprint commit as a release</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_undo</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">blueprints_workspace</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<dd><p>Push the blueprint TOML to the temporary workspace storage</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">prettyCommitDetails</tt><big>(</big><em>change</em>, <em>indent=4</em><big>)</big><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>
<dd><p>Print the blueprint’s change in a nice way</p>
<li><strong>indent</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – Number of spaces to indent</li>
<ttclass="descclassname">composer.cli.blueprints.</tt><ttclass="descname">prettyDiffEntry</tt><big>(</big><em>diff</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/blueprints.html#prettyDiffEntry"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.blueprints.prettyDiffEntry"title="Permalink to this definition">¶</a></dt>
<spanid="compose-module"></span><h2><ttclass="xref py py-mod docutils literal"><spanclass="pre">compose</span></tt> Module<aclass="headerlink"href="#module-composer.cli.compose"title="Permalink to this headline">¶</a></h2>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_cancel</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_cancel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_cancel"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<li><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – unused in this function</li>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_cmd</tt><big>(</big><em>opts</em><big>)</big><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>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_delete</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_delete"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a finished compose’s results</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<li><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – unused in this function</li>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_details</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_details"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_details"title="Permalink to this definition">¶</a></dt>
<dd><p>Return detailed information about the compose</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<li><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – unused in this function</li>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_image</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_image"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_image"title="Permalink to this definition">¶</a></dt>
<dd><p>Download the compose’s output image</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<li><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – unused in this function</li>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_log</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_log"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_log"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<li><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – unused in this function</li>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_logs</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_logs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_logs"title="Permalink to this definition">¶</a></dt>
<dd><p>Download a tar of the compose’s logs</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<li><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – unused in this function</li>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_metadata</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_metadata"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_metadata"title="Permalink to this definition">¶</a></dt>
<dd><p>Download a tar file of the compose’s metadata</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<li><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – unused in this function</li>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_results</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_results"title="Permalink to this definition">¶</a></dt>
<dd><p>Download a tar file of the compose’s results</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<li><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – unused in this function</li>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_start</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_start"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_start"title="Permalink to this definition">¶</a></dt>
<dd><p>Start a new compose using the selected blueprint and type</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<li><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – Set to 1 to simulate a failed compose, set to 2 to simulate a finished one.</li>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_status</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_status"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_status"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the status of all known composes</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<li><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – unused in this function</li>
<ttclass="descclassname">composer.cli.compose.</tt><ttclass="descname">compose_types</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><big>)</big><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_types"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_types"title="Permalink to this definition">¶</a></dt>
<dd><p>Return information about the supported compose types</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<li><strong>testmode</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#int"title="(in Python v2.7)"><em>int</em></a>) – unused in this function</li>
<spanid="modules-module"></span><h2><ttclass="xref py py-mod docutils literal"><spanclass="pre">modules</span></tt> Module<aclass="headerlink"href="#module-composer.cli.modules"title="Permalink to this headline">¶</a></h2>
<ttclass="descclassname">composer.cli.modules.</tt><ttclass="descname">modules_cmd</tt><big>(</big><em>opts</em><big>)</big><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="projects-module"></span><h2><ttclass="xref py py-mod docutils literal"><spanclass="pre">projects</span></tt> Module<aclass="headerlink"href="#module-composer.cli.projects"title="Permalink to this headline">¶</a></h2>
<dlclass="function">
<dtid="composer.cli.projects.projects_cmd">
<ttclass="descclassname">composer.cli.projects.</tt><ttclass="descname">projects_cmd</tt><big>(</big><em>opts</em><big>)</big><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>
<ttclass="descclassname">composer.cli.projects.</tt><ttclass="descname">projects_info</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<ttclass="descclassname">composer.cli.projects.</tt><ttclass="descname">projects_list</tt><big>(</big><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em><big>)</big><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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Path to the Unix socket to use for API communication</li>
<li><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#str"title="(in Python v2.7)"><em>str</em></a>) – Version of the API to talk to. eg. “0”</li>
<li><strong>args</strong> (<em>list of str</em>) – List of remaining arguments from the cmdline</li>
<li><strong>show_json</strong> (<aclass="reference external"href="https://docs.python.org/2/library/functions.html#bool"title="(in Python v2.7)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
<spanid="utilities-module"></span><h2><ttclass="xref py py-mod docutils literal"><spanclass="pre">utilities</span></tt> Module<aclass="headerlink"href="#module-composer.cli.utilities"title="Permalink to this headline">¶</a></h2>
<dlclass="function">
<dtid="composer.cli.utilities.argify">
<ttclass="descclassname">composer.cli.utilities.</tt><ttclass="descname">argify</tt><big>(</big><em>args</em><big>)</big><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>
<dd><p>Take a list of human args and return a list with each item</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>args</strong> (<em>list of str</em>) – list of strings with possible commas and spaces</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">List of all the items</td>
</tr>
<trclass="field-odd field"><thclass="field-name">Return type:</th><tdclass="field-body">list of str</td>
<ttclass="descclassname">composer.cli.utilities.</tt><ttclass="descname">frozen_toml_filename</tt><big>(</big><em>blueprint_name</em><big>)</big><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>
<dd><p>Convert a blueprint name into a filename.toml</p>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">The blueprint name with ‘‘ converted to - and .toml appended</td>
<ttclass="descclassname">composer.cli.utilities.</tt><ttclass="descname">handle_api_result</tt><big>(</big><em>result</em>, <em>show_json=False</em><big>)</big><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>
<dd><p>Log any errors, return the correct value</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>result</strong> (<aclass="reference external"href="https://docs.python.org/2/library/stdtypes.html#dict"title="(in Python v2.7)"><em>dict</em></a>) – JSON result from the http query</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.utilities.packageNEVRA">
<ttclass="descclassname">composer.cli.utilities.</tt><ttclass="descname">packageNEVRA</tt><big>(</big><em>pkg</em><big>)</big><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>
<ttclass="descclassname">composer.cli.utilities.</tt><ttclass="descname">toml_filename</tt><big>(</big><em>blueprint_name</em><big>)</big><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>
<dd><p>Convert a blueprint name into a filename.toml</p>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">The blueprint name with ‘‘ converted to - and .toml appended</td>
