519 lines
36 KiB
HTML
519 lines
36 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
|
|
<title>CPL_CLI — Common Python Library documentation</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
<script src="_static/jquery.js"></script>
|
|
<script src="_static/underscore.js"></script>
|
|
<script src="_static/doctools.js"></script>
|
|
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|
|
|
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="cpl_cli.command" href="cpl_cli.command.html" />
|
|
<link rel="prev" title="cpl.utils" href="cpl.utils.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">CPL_CLI</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html">cpl_cli.configuration</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.live_server.html">cpl_cli.live_server</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl_cli.publish</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html">cpl_cli.source_creator</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.cli">cpl_cli.cli</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.error">cpl_cli.error</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.main">cpl_cli.main</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli.startup">cpl_cli.startup</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_cli">Module contents</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#sh-cpl-cli-sh-edraft-common-python-library-cli">sh_cpl-cli sh-edraft Common Python library CLI</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">Common Python Library</a>
|
|
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
|
|
|
<li>CPL_CLI</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="_sources/cpl_cli.rst.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="cpl-cli">
|
|
<h1>CPL_CLI<a class="headerlink" href="#cpl-cli" title="Permalink to this headline">¶</a></h1>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.add_service">cpl_cli.command.add_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.build_service">cpl_cli.command.build_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.generate_service">cpl_cli.command.generate_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.help_service">cpl_cli.command.help_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.install_service">cpl_cli.command.install_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.new_service">cpl_cli.command.new_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.publish_service">cpl_cli.command.publish_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.remove_service">cpl_cli.command.remove_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.start_service">cpl_cli.command.start_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.uninstall_service">cpl_cli.command.uninstall_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.update_service">cpl_cli.command.update_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html#module-cpl_cli.command.version_service">cpl_cli.command.version_service module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.configuration.html">cpl_cli.configuration</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.build_settings">cpl_cli.configuration.build_settings module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.build_settings_name_enum">cpl_cli.configuration.build_settings_name_enum module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_settings">cpl_cli.configuration.project_settings module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_settings_name_enum">cpl_cli.configuration.project_settings_name_enum module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_type_enum">cpl_cli.configuration.project_type_enum module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.settings_helper">cpl_cli.configuration.settings_helper module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.version_settings">cpl_cli.configuration.version_settings module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.version_settings_name_enum">cpl_cli.configuration.version_settings_name_enum module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.workspace_settings">cpl_cli.configuration.workspace_settings module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html#module-cpl_cli.configuration.workspace_settings_name_enum">cpl_cli.configuration.workspace_settings_name_enum module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.live_server.html">cpl_cli.live_server</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.live_server.html#module-cpl_cli.live_server.live_server_service">cpl_cli.live_server.live_server_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.live_server.html#module-cpl_cli.live_server.live_server_thread">cpl_cli.live_server.live_server_thread module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.publish.html">cpl_cli.publish</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html#module-cpl_cli.publish.publisher_abc">cpl_cli.publish.publisher_abc module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html#module-cpl_cli.publish.publisher_service">cpl_cli.publish.publisher_service module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.source_creator.html">cpl_cli.source_creator</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.console_builder">cpl_cli.source_creator.console_builder module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.library_builder">cpl_cli.source_creator.library_builder module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.template_builder">cpl_cli.source_creator.template_builder module</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="module-cpl_cli.cli">
|
|
<span id="cpl-cli-cli"></span><h2>cpl_cli.cli<a class="headerlink" href="#module-cpl_cli.cli" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="py class">
|
|
<dt id="cpl_cli.cli.CLI">
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.cli.</span></code><code class="sig-name descname"><span class="pre">CLI</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.cli.CLI" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="cpl.application.html#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC</span></code></a></p>
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.cli.CLI.configure">
|
|
<code class="sig-name descname"><span class="pre">configure</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.cli.CLI.configure" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Prepare the application
|
|
:return:</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.cli.CLI.main">
|
|
<code class="sig-name descname"><span class="pre">main</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.cli.CLI.main" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Entry point of the CPL CLI
|
|
:return:</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-cpl_cli.cli_settings">
|
|
<span id="cpl-cli-cli-settings"></span><h2>cpl_cli.cli_settings<a class="headerlink" href="#module-cpl_cli.cli_settings" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="py class">
|
|
<dt id="cpl_cli.cli_settings.CLISettings">
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.cli_settings.</span></code><code class="sig-name descname"><span class="pre">CLISettings</span></code><a class="headerlink" href="#cpl_cli.cli_settings.CLISettings" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.cli_settings.CLISettings.from_dict">
|
|
<code class="sig-name descname"><span class="pre">from_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.cli_settings.CLISettings.from_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Converts attributes to dict
|
|
:param settings:
|
|
:return:</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.cli_settings.CLISettings.pip_path">
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">pip_path</span></code><a class="headerlink" href="#cpl_cli.cli_settings.CLISettings.pip_path" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-cpl_cli.cli_settings_name_enum">
|
|
<span id="cpl-cli-cli-settings-name-enum"></span><h2>cpl_cli.cli_settings_name_enum<a class="headerlink" href="#module-cpl_cli.cli_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="py class">
|
|
<dt id="cpl_cli.cli_settings_name_enum.CLISettingsNameEnum">
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.cli_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">CLISettingsNameEnum</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.cli_settings_name_enum.CLISettingsNameEnum" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
|
<p>An enumeration.</p>
|
|
<dl class="py attribute">
|
|
<dt id="cpl_cli.cli_settings_name_enum.CLISettingsNameEnum.pip_path">
|
|
<code class="sig-name descname"><span class="pre">pip_path</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'PipPath'</span></em><a class="headerlink" href="#cpl_cli.cli_settings_name_enum.CLISettingsNameEnum.pip_path" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-cpl_cli.command_abc">
|
|
<span id="cpl-cli-command-abc"></span><h2>cpl_cli.command_abc<a class="headerlink" href="#module-cpl_cli.command_abc" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="py class">
|
|
<dt id="cpl_cli.command_abc.CommandABC">
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command_abc.</span></code><code class="sig-name descname"><span class="pre">CommandABC</span></code><a class="headerlink" href="#cpl_cli.command_abc.CommandABC" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_abc.CommandABC.help_message">
|
|
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">help_message</span></code><a class="headerlink" href="#cpl_cli.command_abc.CommandABC.help_message" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_abc.CommandABC.run">
|
|
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_abc.CommandABC.run" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-cpl_cli.command_handler_service">
|
|
<span id="cpl-cli-command-handler-service"></span><h2>cpl_cli.command_handler_service<a class="headerlink" href="#module-cpl_cli.command_handler_service" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="py class">
|
|
<dt id="cpl_cli.command_handler_service.CommandHandler">
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command_handler_service.</span></code><code class="sig-name descname"><span class="pre">CommandHandler</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_handler_service.CommandHandler" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_handler_service.CommandHandler.add_command">
|
|
<code class="sig-name descname"><span class="pre">add_command</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_cli.command_model.CommandModel" title="cpl_cli.command_model.CommandModel"><span class="pre">cpl_cli.command_model.CommandModel</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_handler_service.CommandHandler.add_command" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_handler_service.CommandHandler.commands">
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">commands</span></code><a class="headerlink" href="#cpl_cli.command_handler_service.CommandHandler.commands" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_handler_service.CommandHandler.handle">
|
|
<code class="sig-name descname"><span class="pre">handle</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_handler_service.CommandHandler.handle" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Handles incoming commands and args
|
|
:param cmd:
|
|
:param args:
|
|
:return:</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_handler_service.CommandHandler.remove_command">
|
|
<code class="sig-name descname"><span class="pre">remove_command</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_cli.command_model.CommandModel" title="cpl_cli.command_model.CommandModel"><span class="pre">cpl_cli.command_model.CommandModel</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_handler_service.CommandHandler.remove_command" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-cpl_cli.command_model">
|
|
<span id="cpl-cli-command-model"></span><h2>cpl_cli.command_model<a class="headerlink" href="#module-cpl_cli.command_model" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="py class">
|
|
<dt id="cpl_cli.command_model.CommandModel">
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command_model.</span></code><code class="sig-name descname"><span class="pre">CommandModel</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">command</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><span class="pre">cpl_cli.command_abc.CommandABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_workspace_needed</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_project_needed</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">change_cwd</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command_model.CommandModel" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_model.CommandModel.aliases">
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">aliases</span></code><a class="headerlink" href="#cpl_cli.command_model.CommandModel.aliases" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_model.CommandModel.change_cwd">
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">change_cwd</span></code><a class="headerlink" href="#cpl_cli.command_model.CommandModel.change_cwd" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_model.CommandModel.command">
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">command</span></code><a class="headerlink" href="#cpl_cli.command_model.CommandModel.command" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_model.CommandModel.is_project_needed">
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">is_project_needed</span></code><a class="headerlink" href="#cpl_cli.command_model.CommandModel.is_project_needed" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_model.CommandModel.is_workspace_needed">
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">is_workspace_needed</span></code><a class="headerlink" href="#cpl_cli.command_model.CommandModel.is_workspace_needed" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.command_model.CommandModel.name">
|
|
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">name</span></code><a class="headerlink" href="#cpl_cli.command_model.CommandModel.name" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-cpl_cli.error">
|
|
<span id="cpl-cli-error"></span><h2>cpl_cli.error<a class="headerlink" href="#module-cpl_cli.error" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="py class">
|
|
<dt id="cpl_cli.error.Error">
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.error.</span></code><code class="sig-name descname"><span class="pre">Error</span></code><a class="headerlink" href="#cpl_cli.error.Error" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.error.Error.error">
|
|
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">error</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.error.Error.error" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.error.Error.warn">
|
|
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">warn</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.error.Error.warn" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-cpl_cli.main">
|
|
<span id="cpl-cli-main"></span><h2>cpl_cli.main<a class="headerlink" href="#module-cpl_cli.main" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="py function">
|
|
<dt id="cpl_cli.main.main">
|
|
<code class="sig-prename descclassname"><span class="pre">cpl_cli.main.</span></code><code class="sig-name descname"><span class="pre">main</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.main.main" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-cpl_cli.startup">
|
|
<span id="cpl-cli-startup"></span><h2>cpl_cli.startup<a class="headerlink" href="#module-cpl_cli.startup" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="py class">
|
|
<dt id="cpl_cli.startup.Startup">
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.startup.</span></code><code class="sig-name descname"><span class="pre">Startup</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.dependency_injection.html#cpl.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">cpl.dependency_injection.service_collection_abc.ServiceCollectionABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.startup.Startup" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="cpl.application.html#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a></p>
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.startup.Startup.configure_configuration">
|
|
<code class="sig-name descname"><span class="pre">configure_configuration</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a><a class="headerlink" href="#cpl_cli.startup.Startup.configure_configuration" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Creates configuration of application
|
|
:return: configuration</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="cpl_cli.startup.Startup.configure_services">
|
|
<code class="sig-name descname"><span class="pre">configure_services</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="cpl.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><a class="headerlink" href="#cpl_cli.startup.Startup.configure_services" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Creates service provider
|
|
:return: service provider</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-cpl_cli">
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_cli" title="Permalink to this headline">¶</a></h2>
|
|
<div class="section" id="sh-cpl-cli-sh-edraft-common-python-library-cli">
|
|
<h3>sh_cpl-cli sh-edraft Common Python library CLI<a class="headerlink" href="#sh-cpl-cli-sh-edraft-common-python-library-cli" title="Permalink to this headline">¶</a></h3>
|
|
<p>sh-edraft Common Python library Command Line Interface</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">copyright</dt>
|
|
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
|
<li><p>2020 - 2021 sh-edraft.de</p></li>
|
|
</ol>
|
|
</dd>
|
|
<dt class="field-even">license</dt>
|
|
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="py class">
|
|
<dt id="cpl_cli.VersionInfo">
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.</span></code><code class="sig-name descname"><span class="pre">VersionInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.VersionInfo" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
|
<dl class="py attribute">
|
|
<dt id="cpl_cli.VersionInfo.major">
|
|
<code class="sig-name descname"><span class="pre">major</span></code><a class="headerlink" href="#cpl_cli.VersionInfo.major" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Alias for field number 0</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="cpl_cli.VersionInfo.micro">
|
|
<code class="sig-name descname"><span class="pre">micro</span></code><a class="headerlink" href="#cpl_cli.VersionInfo.micro" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Alias for field number 2</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="cpl_cli.VersionInfo.minor">
|
|
<code class="sig-name descname"><span class="pre">minor</span></code><a class="headerlink" href="#cpl_cli.VersionInfo.minor" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Alias for field number 1</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
<a href="cpl_cli.command.html" class="btn btn-neutral float-right" title="cpl_cli.command" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
<a href="cpl.utils.html" class="btn btn-neutral float-left" title="cpl.utils" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2021, Sven Heidemann.
|
|
|
|
</p>
|
|
</div>
|
|
|
|
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |