<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="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_changes</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>blueprints changes <blueprint,…> Display the changes for each blueprint.</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.blueprints.blueprints_cmd">
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_cmd</code><spanclass="sig-paren">(</span><em>opts</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="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_delete</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>delete <blueprint> Delete a blueprint from the server</p>
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_depsolve</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>blueprints depsolve <blueprint,…> Display the packages needed to install the blueprint.</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.blueprints.blueprints_diff">
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_diff</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dlclass="docutils">
<dt>blueprints diff <blueprint-name> Display the differences between 2 versions of a blueprint.</dt>
<dd><from-commit> Commit hash or NEWEST
<to-commit> Commit hash, NEWEST, or WORKSPACE</dd>
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_freeze</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>blueprints freeze <blueprint,…> Display the frozen blueprint’s modules and packages.
blueprints freeze show <blueprint,…> Display the frozen blueprint in TOML format.
blueprints freeze save <blueprint,…> Save the frozen blueprint to a file, <blueprint-name>.frozen.toml.</p>
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_freeze_save</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>blueprints freeze save <blueprint,…> Save the frozen blueprint to a file, <blueprint-name>.frozen.toml.</p>
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_freeze_show</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>blueprints freeze show <blueprint,…> Display the frozen blueprint in TOML format.</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.blueprints.blueprints_list">
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_list</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>blueprints list</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.blueprints.blueprints_push">
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_push</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>push <blueprint> Push a blueprint TOML file to the server.</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.blueprints.blueprints_save">
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_save</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>blueprints save <blueprint,…> Save the blueprint to a file, <blueprint-name>.toml</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.blueprints.blueprints_show">
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_show</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>blueprints show <blueprint,…> Display the blueprint in TOML format.</p>
<p>Multiple blueprints will be separated by</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.blueprints.blueprints_tag">
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_tag</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>blueprints tag <blueprint> Tag the most recent blueprint commit as a release.</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.blueprints.blueprints_undo">
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_undo</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>blueprints undo <blueprint><commit> Undo changes to a blueprint by reverting to the selected commit.</p>
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">blueprints_workspace</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>blueprints workspace <blueprint> Push the blueprint TOML to the temporary workspace storage.</p>
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">prettyCommitDetails</code><spanclass="sig-paren">(</span><em>change</em>, <em>indent=4</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>
<dd><p>Print the blueprint’s change in a nice way</p>
<li><strong>indent</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – Number of spaces to indent</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.blueprints.prettyDiffEntry">
<codeclass="descclassname">composer.cli.blueprints.</code><codeclass="descname">prettyDiffEntry</code><spanclass="sig-paren">(</span><em>diff</em><spanclass="sig-paren">)</span><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="composer-cli-cmdline-module"></span><h2>composer.cli.cmdline module<aclass="headerlink"href="#module-composer.cli.cmdline"title="Permalink to this headline">¶</a></h2>
<dlclass="function">
<dtid="composer.cli.cmdline.composer_cli_parser">
<codeclass="descclassname">composer.cli.cmdline.</code><codeclass="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>
<dd><p>Return the ArgumentParser for composer-cli</p>
<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>
<dlclass="function">
<dtid="composer.cli.compose.compose_cancel">
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_cancel</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><spanclass="sig-paren">)</span><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><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/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – unused in this function</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>compose cancel <uuid></p>
<p>This will cancel a running compose. It does nothing if the compose has finished.</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.compose.compose_cmd">
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_cmd</code><spanclass="sig-paren">(</span><em>opts</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>
<p>This dispatches the compose commands to a function</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.compose.compose_delete">
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_delete</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><spanclass="sig-paren">)</span><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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><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/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – unused in this function</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>compose delete <uuid,…></p>
<p>Delete the listed compose results. It will only delete results for composes that have finished
or failed, not a running compose.</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.compose.compose_image">
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_image</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><spanclass="sig-paren">)</span><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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><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/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – unused in this function</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>compose image <uuid></p>
<p>This downloads only the result image, saving it as the image name, which depends on the type
of compose that was selected.</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.compose.compose_info">
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_info</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/cli/compose.html#compose_info"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.cli.compose.compose_info"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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><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/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – unused in this function</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>compose info <uuid></p>
<p>This returns information about the compose, including the blueprint and the dependencies.</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.compose.compose_log">
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_log</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><spanclass="sig-paren">)</span><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><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/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – unused in this function</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>compose log <uuid> [<size>kB]</p>
<p>This will display the last 1kB of the compose’s log file. Can be used to follow progress
during the build.</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.compose.compose_logs">
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_logs</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><spanclass="sig-paren">)</span><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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><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/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – unused in this function</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>compose logs <uuid></p>
<p>Saves the logs as uuid-logs.tar</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.compose.compose_metadata">
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_metadata</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><spanclass="sig-paren">)</span><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><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/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – unused in this function</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>compose metadata <uuid></p>
<p>Saves the metadata as uuid-metadata.tar</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.compose.compose_results">
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_results</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><spanclass="sig-paren">)</span><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><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/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – unused in this function</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>compose results <uuid></p>
<p>The results includes the metadata, output image, and logs.
It is saved as uuid.tar</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.compose.compose_start">
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_start</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><spanclass="sig-paren">)</span><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><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/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – Set to 1 to simulate a failed compose, set to 2 to simulate a finished one.</li>
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_status</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><spanclass="sig-paren">)</span><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><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/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – unused in this function</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>This doesn’t map directly to an API command, it combines the results from queue, finished,
and failed so raw JSON output is not available.</p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.compose.compose_types">
<codeclass="descclassname">composer.cli.compose.</code><codeclass="descname">compose_types</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</em>, <em>testmode=0</em><spanclass="sig-paren">)</span><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><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/3/library/functions.html#int"title="(in Python v3.6)"><em>int</em></a>) – unused in this function</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Add additional details to types that are known to composer-cli. Raw JSON output does not
<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>
<dlclass="function">
<dtid="composer.cli.modules.modules_cmd">
<codeclass="descclassname">composer.cli.modules.</code><codeclass="descname">modules_cmd</code><spanclass="sig-paren">(</span><em>opts</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>
<dlclass="function">
<dtid="composer.cli.projects.projects_cmd">
<codeclass="descclassname">composer.cli.projects.</code><codeclass="descname">projects_cmd</code><spanclass="sig-paren">(</span><em>opts</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="descclassname">composer.cli.projects.</code><codeclass="descname">projects_info</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>projects info <project,…></p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.projects.projects_list">
<codeclass="descclassname">composer.cli.projects.</code><codeclass="descname">projects_list</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</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>
<dlclass="function">
<dtid="composer.cli.sources.sources_add">
<codeclass="descclassname">composer.cli.sources.</code><codeclass="descname">sources_add</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>sources add <source.toml></p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.sources.sources_cmd">
<codeclass="descclassname">composer.cli.sources.</code><codeclass="descname">sources_cmd</code><spanclass="sig-paren">(</span><em>opts</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="descclassname">composer.cli.sources.</code><codeclass="descname">sources_delete</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>sources delete <source-name></p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.sources.sources_info">
<codeclass="descclassname">composer.cli.sources.</code><codeclass="descname">sources_info</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>sources info <source-name></p>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.sources.sources_list">
<codeclass="descclassname">composer.cli.sources.</code><codeclass="descname">sources_list</code><spanclass="sig-paren">(</span><em>socket_path</em>, <em>api_version</em>, <em>args</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/stdtypes.html#str"title="(in Python v3.6)"><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/3/library/functions.html#bool"title="(in Python v3.6)"><em>bool</em></a>) – Set to True to show the JSON output instead of the human readable output</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>
<dlclass="function">
<dtid="composer.cli.utilities.argify">
<codeclass="descclassname">composer.cli.utilities.</code><codeclass="descname">argify</code><spanclass="sig-paren">(</span><em>args</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>
<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>
<codeclass="descclassname">composer.cli.utilities.</code><codeclass="descname">frozen_toml_filename</code><spanclass="sig-paren">(</span><em>blueprint_name</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>
<dd><p>Convert a blueprint name into a filename.toml</p>
<codeclass="descclassname">composer.cli.utilities.</code><codeclass="descname">handle_api_result</code><spanclass="sig-paren">(</span><em>result</em>, <em>show_json=False</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>
<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/3/library/stdtypes.html#dict"title="(in Python v3.6)"><em>dict</em></a>) – JSON result from the http query</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="composer.cli.utilities.packageNEVRA">
<codeclass="descclassname">composer.cli.utilities.</code><codeclass="descname">packageNEVRA</code><spanclass="sig-paren">(</span><em>pkg</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="descclassname">composer.cli.utilities.</code><codeclass="descname">toml_filename</code><spanclass="sig-paren">(</span><em>blueprint_name</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>
<dd><p>Convert a blueprint name into a filename.toml</p>
<spanid="module-contents"></span><h2>Module contents<aclass="headerlink"href="#module-composer.cli"title="Permalink to this headline">¶</a></h2>
<dlclass="function">
<dtid="composer.cli.main">
<codeclass="descclassname">composer.cli.</code><codeclass="descname">main</code><spanclass="sig-paren">(</span><em>opts</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>.
