Added cpl_cli docs & moved cpl_cli/templates -> cpl_cli/_templates

This commit is contained in:
Sven Heidemann 2021-04-14 10:58:47 +02:00
parent 478f1ad0ff
commit ed1a4eb88c
117 changed files with 4880 additions and 269 deletions

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
docs/build/doctrees/cpl_cli.doctree vendored Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
docs/build/doctrees/tests.doctree vendored Normal file

Binary file not shown.

View File

@ -0,0 +1,98 @@
cpl\_cli.command
========================
cpl\_cli.command.add\_service module
------------------------------------
.. automodule:: cpl_cli.command.add_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.build\_service module
--------------------------------------
.. automodule:: cpl_cli.command.build_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.generate\_service module
-----------------------------------------
.. automodule:: cpl_cli.command.generate_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.help\_service module
-------------------------------------
.. automodule:: cpl_cli.command.help_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.install\_service module
----------------------------------------
.. automodule:: cpl_cli.command.install_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.new\_service module
------------------------------------
.. automodule:: cpl_cli.command.new_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.publish\_service module
----------------------------------------
.. automodule:: cpl_cli.command.publish_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.remove\_service module
---------------------------------------
.. automodule:: cpl_cli.command.remove_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.start\_service module
--------------------------------------
.. automodule:: cpl_cli.command.start_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.uninstall\_service module
------------------------------------------
.. automodule:: cpl_cli.command.uninstall_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.update\_service module
---------------------------------------
.. automodule:: cpl_cli.command.update_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.version\_service module
----------------------------------------
.. automodule:: cpl_cli.command.version_service
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,82 @@
cpl\_cli.configuration
==============================
cpl\_cli.configuration.build\_settings module
---------------------------------------------
.. automodule:: cpl_cli.configuration.build_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.build\_settings\_name\_enum module
---------------------------------------------------------
.. automodule:: cpl_cli.configuration.build_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.project\_settings module
-----------------------------------------------
.. automodule:: cpl_cli.configuration.project_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.project\_settings\_name\_enum module
-----------------------------------------------------------
.. automodule:: cpl_cli.configuration.project_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.project\_type\_enum module
-------------------------------------------------
.. automodule:: cpl_cli.configuration.project_type_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.settings\_helper module
----------------------------------------------
.. automodule:: cpl_cli.configuration.settings_helper
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.version\_settings module
-----------------------------------------------
.. automodule:: cpl_cli.configuration.version_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.version\_settings\_name\_enum module
-----------------------------------------------------------
.. automodule:: cpl_cli.configuration.version_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.workspace\_settings module
-------------------------------------------------
.. automodule:: cpl_cli.configuration.workspace_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.workspace\_settings\_name\_enum module
-------------------------------------------------------------
.. automodule:: cpl_cli.configuration.workspace_settings_name_enum
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,18 @@
cpl\_cli.live\_server
=============================
cpl\_cli.live\_server.live\_server\_service module
--------------------------------------------------
.. automodule:: cpl_cli.live_server.live_server_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.live\_server.live\_server\_thread module
-------------------------------------------------
.. automodule:: cpl_cli.live_server.live_server_thread
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,18 @@
cpl\_cli.publish
========================
cpl\_cli.publish.publisher\_abc module
--------------------------------------
.. automodule:: cpl_cli.publish.publisher_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.publish.publisher\_service module
------------------------------------------
.. automodule:: cpl_cli.publish.publisher_service
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,92 @@
CPL_CLI
================
.. toctree::
:maxdepth: 4
cpl_cli.command
cpl_cli.configuration
cpl_cli.live_server
cpl_cli.publish
cpl_cli.source_creator
cpl_cli.templates
cpl\_cli.cli
-------------------
.. automodule:: cpl_cli.cli
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.cli\_settings
-----------------------------
.. automodule:: cpl_cli.cli_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.cli\_settings\_name\_enum
-----------------------------------------
.. automodule:: cpl_cli.cli_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command\_abc
----------------------------
.. automodule:: cpl_cli.command_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command\_handler\_service
-----------------------------------------
.. automodule:: cpl_cli.command_handler_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command\_model
------------------------------
.. automodule:: cpl_cli.command_model
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.error
---------------------
.. automodule:: cpl_cli.error
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.main
--------------------
.. automodule:: cpl_cli.main
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.startup
-----------------------
.. automodule:: cpl_cli.startup
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_cli
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,26 @@
cpl\_cli.source\_creator
================================
cpl\_cli.source\_creator.console\_builder module
------------------------------------------------
.. automodule:: cpl_cli.source_creator.console_builder
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.source\_creator.library\_builder module
------------------------------------------------
.. automodule:: cpl_cli.source_creator.library_builder
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.source\_creator.template\_builder module
-------------------------------------------------
.. automodule:: cpl_cli.source_creator.template_builder
:members:
:undoc-members:
:show-inheritance:

View File

@ -2,6 +2,7 @@ cpl
=== ===
.. toctree:: .. toctree::
:maxdepth: 4 :maxdepth: 4
cpl cpl
cpl_cli

10
docs/build/html/_sources/tests.rst.txt vendored Normal file
View File

@ -0,0 +1,10 @@
tests package
=============
Module contents
---------------
.. automodule:: tests
:members:
:undoc-members:
:show-inheritance:

View File

@ -105,6 +105,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -106,6 +106,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -106,6 +106,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -111,6 +111,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -111,6 +111,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -107,6 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -107,6 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -104,6 +104,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -102,6 +102,7 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -106,6 +106,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -106,6 +106,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -103,6 +103,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

View File

@ -38,6 +38,7 @@
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="CPL_CLI" href="cpl_cli.html" />
<link rel="prev" title="cpl.time" href="cpl.time.html" /> <link rel="prev" title="cpl.time" href="cpl.time.html" />
</head> </head>
@ -103,6 +104,7 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li> <li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>
@ -332,6 +334,7 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CPL_CLI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl.time.html" class="btn btn-neutral float-left" title="cpl.time" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="cpl.time.html" class="btn btn-neutral float-left" title="cpl.time" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>

506
docs/build/html/cpl_cli.command.html vendored Normal file
View File

@ -0,0 +1,506 @@
<!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.command &mdash; 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.configuration" href="cpl_cli.configuration.html" />
<link rel="prev" title="CPL_CLI" href="cpl_cli.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="reference internal" href="cpl_cli.html">CPL_CLI</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_cli.command</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.add_service">cpl_cli.command.add_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.build_service">cpl_cli.command.build_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.generate_service">cpl_cli.command.generate_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.help_service">cpl_cli.command.help_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.install_service">cpl_cli.command.install_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.new_service">cpl_cli.command.new_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.publish_service">cpl_cli.command.publish_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.remove_service">cpl_cli.command.remove_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.start_service">cpl_cli.command.start_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.uninstall_service">cpl_cli.command.uninstall_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.update_service">cpl_cli.command.update_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.command.version_service">cpl_cli.command.version_service module</a></li>
</ul>
</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="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a></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> &raquo;</li>
<li><a href="cpl_cli.html">CPL_CLI</a> &raquo;</li>
<li>cpl_cli.command</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.command.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-command">
<h1>cpl_cli.command<a class="headerlink" href="#cpl-cli-command" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl_cli.command.add_service">
<span id="cpl-cli-command-add-service-module"></span><h2>cpl_cli.command.add_service module<a class="headerlink" href="#module-cpl_cli.command.add_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.add_service.AddService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.add_service.</span></code><code class="sig-name descname"><span class="pre">AddService</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">workspace</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.workspace_settings.WorkspaceSettings" title="cpl_cli.configuration.workspace_settings.WorkspaceSettings"><span class="pre">cpl_cli.configuration.workspace_settings.WorkspaceSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.add_service.AddService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.add_service.AddService.help_message">
<em class="property"><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.add_service.AddService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.add_service.AddService.run">
<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.add_service.AddService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.command.build_service">
<span id="cpl-cli-command-build-service-module"></span><h2>cpl_cli.command.build_service module<a class="headerlink" href="#module-cpl_cli.command.build_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.build_service.BuildService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.build_service.</span></code><code class="sig-name descname"><span class="pre">BuildService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">publisher</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.publish.html#cpl_cli.publish.publisher_abc.PublisherABC" title="cpl_cli.publish.publisher_abc.PublisherABC"><span class="pre">cpl_cli.publish.publisher_abc.PublisherABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.build_service.BuildService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.build_service.BuildService.help_message">
<em class="property"><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.build_service.BuildService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.build_service.BuildService.run">
<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.build_service.BuildService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.command.generate_service">
<span id="cpl-cli-command-generate-service-module"></span><h2>cpl_cli.command.generate_service module<a class="headerlink" href="#module-cpl_cli.command.generate_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.generate_service.GenerateService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.generate_service.</span></code><code class="sig-name descname"><span class="pre">GenerateService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">configuration</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><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.generate_service.GenerateService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.generate_service.GenerateService.help_message">
<em class="property"><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.generate_service.GenerateService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.generate_service.GenerateService.run">
<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.generate_service.GenerateService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.command.help_service">
<span id="cpl-cli-command-help-service-module"></span><h2>cpl_cli.command.help_service module<a class="headerlink" href="#module-cpl_cli.command.help_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.help_service.HelpService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.help_service.</span></code><code class="sig-name descname"><span class="pre">HelpService</span></code><span class="sig-paren">(</span><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>, <em class="sig-param"><span class="n"><span class="pre">cmd_handler</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.html#cpl_cli.command_handler_service.CommandHandler" title="cpl_cli.command_handler_service.CommandHandler"><span class="pre">cpl_cli.command_handler_service.CommandHandler</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.help_service.HelpService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.help_service.HelpService.help_message">
<em class="property"><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.help_service.HelpService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.help_service.HelpService.run">
<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.help_service.HelpService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.command.install_service">
<span id="cpl-cli-command-install-service-module"></span><h2>cpl_cli.command.install_service module<a class="headerlink" href="#module-cpl_cli.command.install_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.install_service.InstallService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.install_service.</span></code><code class="sig-name descname"><span class="pre">InstallService</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">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">cli_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.html#cpl_cli.cli_settings.CLISettings" title="cpl_cli.cli_settings.CLISettings"><span class="pre">cpl_cli.cli_settings.CLISettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.install_service.InstallService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.install_service.InstallService.help_message">
<em class="property"><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.install_service.InstallService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.install_service.InstallService.run">
<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.install_service.InstallService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.command.new_service">
<span id="cpl-cli-command-new-service-module"></span><h2>cpl_cli.command.new_service module<a class="headerlink" href="#module-cpl_cli.command.new_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.new_service.NewService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.new_service.</span></code><code class="sig-name descname"><span class="pre">NewService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">configuration</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><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.new_service.NewService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.new_service.NewService.help_message">
<em class="property"><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.new_service.NewService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.new_service.NewService.run">
<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.new_service.NewService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.command.publish_service">
<span id="cpl-cli-command-publish-service-module"></span><h2>cpl_cli.command.publish_service module<a class="headerlink" href="#module-cpl_cli.command.publish_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.publish_service.PublishService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.publish_service.</span></code><code class="sig-name descname"><span class="pre">PublishService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">publisher</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.publish.html#cpl_cli.publish.publisher_abc.PublisherABC" title="cpl_cli.publish.publisher_abc.PublisherABC"><span class="pre">cpl_cli.publish.publisher_abc.PublisherABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.publish_service.PublishService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.publish_service.PublishService.help_message">
<em class="property"><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.publish_service.PublishService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.publish_service.PublishService.run">
<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.publish_service.PublishService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.command.remove_service">
<span id="cpl-cli-command-remove-service-module"></span><h2>cpl_cli.command.remove_service module<a class="headerlink" href="#module-cpl_cli.command.remove_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.remove_service.RemoveService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.remove_service.</span></code><code class="sig-name descname"><span class="pre">RemoveService</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">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.remove_service.RemoveService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.remove_service.RemoveService.help_message">
<em class="property"><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.remove_service.RemoveService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.remove_service.RemoveService.run">
<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.remove_service.RemoveService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.command.start_service">
<span id="cpl-cli-command-start-service-module"></span><h2>cpl_cli.command.start_service module<a class="headerlink" href="#module-cpl_cli.command.start_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.start_service.StartService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.start_service.</span></code><code class="sig-name descname"><span class="pre">StartService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">live_server</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.live_server.html#cpl_cli.live_server.live_server_service.LiveServerService" title="cpl_cli.live_server.live_server_service.LiveServerService"><span class="pre">cpl_cli.live_server.live_server_service.LiveServerService</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.start_service.StartService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.start_service.StartService.help_message">
<em class="property"><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.start_service.StartService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.start_service.StartService.run">
<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.start_service.StartService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.command.uninstall_service">
<span id="cpl-cli-command-uninstall-service-module"></span><h2>cpl_cli.command.uninstall_service module<a class="headerlink" href="#module-cpl_cli.command.uninstall_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.uninstall_service.UninstallService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.uninstall_service.</span></code><code class="sig-name descname"><span class="pre">UninstallService</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">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.uninstall_service.UninstallService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.uninstall_service.UninstallService.help_message">
<em class="property"><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.uninstall_service.UninstallService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.uninstall_service.UninstallService.run">
<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.uninstall_service.UninstallService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.command.update_service">
<span id="cpl-cli-command-update-service-module"></span><h2>cpl_cli.command.update_service module<a class="headerlink" href="#module-cpl_cli.command.update_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.update_service.UpdateService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.update_service.</span></code><code class="sig-name descname"><span class="pre">UpdateService</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">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">cli_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.html#cpl_cli.cli_settings.CLISettings" title="cpl_cli.cli_settings.CLISettings"><span class="pre">cpl_cli.cli_settings.CLISettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.command.update_service.UpdateService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.update_service.UpdateService.help_message">
<em class="property"><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.update_service.UpdateService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.update_service.UpdateService.run">
<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.update_service.UpdateService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.command.version_service">
<span id="cpl-cli-command-version-service-module"></span><h2>cpl_cli.command.version_service module<a class="headerlink" href="#module-cpl_cli.command.version_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.command.version_service.VersionService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.command.version_service.</span></code><code class="sig-name descname"><span class="pre">VersionService</span></code><a class="headerlink" href="#cpl_cli.command.version_service.VersionService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_cli.html#cpl_cli.command_abc.CommandABC" title="cpl_cli.command_abc.CommandABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.command_abc.CommandABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.command.version_service.VersionService.help_message">
<em class="property"><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.version_service.VersionService.help_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.command.version_service.VersionService.run">
<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.version_service.VersionService.run" title="Permalink to this definition"></a></dt>
<dd><p>Entry point of command
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_cli.configuration.html" class="btn btn-neutral float-right" title="cpl_cli.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.html" class="btn btn-neutral float-left" title="CPL_CLI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; 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>

View File

@ -0,0 +1,702 @@
<!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.configuration &mdash; 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.live_server" href="cpl_cli.live_server.html" />
<link rel="prev" title="cpl_cli.command" href="cpl_cli.command.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="reference internal" href="cpl_cli.html">CPL_CLI</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_cli.configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.build_settings">cpl_cli.configuration.build_settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.build_settings_name_enum">cpl_cli.configuration.build_settings_name_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.project_settings">cpl_cli.configuration.project_settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.project_settings_name_enum">cpl_cli.configuration.project_settings_name_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.project_type_enum">cpl_cli.configuration.project_type_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.settings_helper">cpl_cli.configuration.settings_helper module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.version_settings">cpl_cli.configuration.version_settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.version_settings_name_enum">cpl_cli.configuration.version_settings_name_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.workspace_settings">cpl_cli.configuration.workspace_settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.configuration.workspace_settings_name_enum">cpl_cli.configuration.workspace_settings_name_enum module</a></li>
</ul>
</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="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a></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> &raquo;</li>
<li><a href="cpl_cli.html">CPL_CLI</a> &raquo;</li>
<li>cpl_cli.configuration</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.configuration.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-configuration">
<h1>cpl_cli.configuration<a class="headerlink" href="#cpl-cli-configuration" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl_cli.configuration.build_settings">
<span id="cpl-cli-configuration-build-settings-module"></span><h2>cpl_cli.configuration.build_settings module<a class="headerlink" href="#module-cpl_cli.configuration.build_settings" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.configuration.build_settings.BuildSettings">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.build_settings.</span></code><code class="sig-name descname"><span class="pre">BuildSettings</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings" 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.configuration.build_settings.BuildSettings.entry_point">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">entry_point</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.entry_point" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.build_settings.BuildSettings.excluded">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">excluded</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.excluded" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.build_settings.BuildSettings.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.configuration.build_settings.BuildSettings.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.configuration.build_settings.BuildSettings.include_package_data">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">include_package_data</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.include_package_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.build_settings.BuildSettings.included">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">included</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.included" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.build_settings.BuildSettings.main">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">main</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.main" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.build_settings.BuildSettings.output_path">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">output_path</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.output_path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.build_settings.BuildSettings.package_data">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">package_data</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.package_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.build_settings.BuildSettings.project_references">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">project_references</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.project_references" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.build_settings.BuildSettings.project_type">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">project_type</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.project_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.build_settings.BuildSettings.source_path">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">source_path</span></code><a class="headerlink" href="#cpl_cli.configuration.build_settings.BuildSettings.source_path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.configuration.build_settings_name_enum">
<span id="cpl-cli-configuration-build-settings-name-enum-module"></span><h2>cpl_cli.configuration.build_settings_name_enum module<a class="headerlink" href="#module-cpl_cli.configuration.build_settings_name_enum" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.build_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">BuildSettingsNameEnum</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.configuration.build_settings_name_enum.BuildSettingsNameEnum" 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.configuration.build_settings_name_enum.BuildSettingsNameEnum.entry_point">
<code class="sig-name descname"><span class="pre">entry_point</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'EntryPoint'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.entry_point" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.excluded">
<code class="sig-name descname"><span class="pre">excluded</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Excluded'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.excluded" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.include_package_data">
<code class="sig-name descname"><span class="pre">include_package_data</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'IncludePackageData'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.include_package_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.included">
<code class="sig-name descname"><span class="pre">included</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Included'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.included" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.main">
<code class="sig-name descname"><span class="pre">main</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Main'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.main" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.output_path">
<code class="sig-name descname"><span class="pre">output_path</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'OutputPath'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.output_path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.package_data">
<code class="sig-name descname"><span class="pre">package_data</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'PackageData'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.package_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.project_references">
<code class="sig-name descname"><span class="pre">project_references</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'ProjectReferences'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.project_references" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.project_type">
<code class="sig-name descname"><span class="pre">project_type</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'ProjectType'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.project_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.source_path">
<code class="sig-name descname"><span class="pre">source_path</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'SourcePath'</span></em><a class="headerlink" href="#cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum.source_path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.configuration.project_settings">
<span id="cpl-cli-configuration-project-settings-module"></span><h2>cpl_cli.configuration.project_settings module<a class="headerlink" href="#module-cpl_cli.configuration.project_settings" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.project_settings.</span></code><code class="sig-name descname"><span class="pre">ProjectSettings</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings" 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.configuration.project_settings.ProjectSettings.author">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">author</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.author" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.author_email">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">author_email</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.author_email" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.classifiers">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">classifiers</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.classifiers" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.copyright_date">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">copyright_date</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.copyright_date" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.copyright_name">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">copyright_name</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.copyright_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.dependencies">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">dependencies</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.dependencies" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.description">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.description" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.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.configuration.project_settings.ProjectSettings.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.configuration.project_settings.ProjectSettings.license_description">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">license_description</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.license_description" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.license_name">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">license_name</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.license_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.long_description">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">long_description</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.long_description" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.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.configuration.project_settings.ProjectSettings.name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.python_executable">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">python_executable</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.python_executable" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.python_path">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">python_path</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.python_path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.python_version">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">python_version</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.python_version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.url">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">url</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.url" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.project_settings.ProjectSettings.version">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">version</span></code><a class="headerlink" href="#cpl_cli.configuration.project_settings.ProjectSettings.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.configuration.project_settings_name_enum">
<span id="cpl-cli-configuration-project-settings-name-enum-module"></span><h2>cpl_cli.configuration.project_settings_name_enum module<a class="headerlink" href="#module-cpl_cli.configuration.project_settings_name_enum" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.project_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">ProjectSettingsNameEnum</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.configuration.project_settings_name_enum.ProjectSettingsNameEnum" 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.configuration.project_settings_name_enum.ProjectSettingsNameEnum.author">
<code class="sig-name descname"><span class="pre">author</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Author'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.author" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.author_email">
<code class="sig-name descname"><span class="pre">author_email</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'AuthorEmail'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.author_email" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.classifiers">
<code class="sig-name descname"><span class="pre">classifiers</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Classifiers'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.classifiers" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.copyright_date">
<code class="sig-name descname"><span class="pre">copyright_date</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'CopyrightDate'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.copyright_date" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.copyright_name">
<code class="sig-name descname"><span class="pre">copyright_name</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'CopyrightName'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.copyright_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.dependencies">
<code class="sig-name descname"><span class="pre">dependencies</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Dependencies'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.dependencies" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.description">
<code class="sig-name descname"><span class="pre">description</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Description'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.description" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.license_description">
<code class="sig-name descname"><span class="pre">license_description</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'LicenseDescription'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.license_description" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.license_name">
<code class="sig-name descname"><span class="pre">license_name</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'LicenseName'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.license_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.long_description">
<code class="sig-name descname"><span class="pre">long_description</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'LongDescription'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.long_description" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.name">
<code class="sig-name descname"><span class="pre">name</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Name'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.python_path">
<code class="sig-name descname"><span class="pre">python_path</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'PythonPath'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.python_path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.python_version">
<code class="sig-name descname"><span class="pre">python_version</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'PythonVersion'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.python_version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.url">
<code class="sig-name descname"><span class="pre">url</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'URL'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.url" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.version">
<code class="sig-name descname"><span class="pre">version</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Version'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum.version" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.configuration.project_type_enum">
<span id="cpl-cli-configuration-project-type-enum-module"></span><h2>cpl_cli.configuration.project_type_enum module<a class="headerlink" href="#module-cpl_cli.configuration.project_type_enum" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.configuration.project_type_enum.ProjectTypeEnum">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.project_type_enum.</span></code><code class="sig-name descname"><span class="pre">ProjectTypeEnum</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.configuration.project_type_enum.ProjectTypeEnum" 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.configuration.project_type_enum.ProjectTypeEnum.console">
<code class="sig-name descname"><span class="pre">console</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'console'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_type_enum.ProjectTypeEnum.console" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.project_type_enum.ProjectTypeEnum.library">
<code class="sig-name descname"><span class="pre">library</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'library'</span></em><a class="headerlink" href="#cpl_cli.configuration.project_type_enum.ProjectTypeEnum.library" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.configuration.settings_helper">
<span id="cpl-cli-configuration-settings-helper-module"></span><h2>cpl_cli.configuration.settings_helper module<a class="headerlink" href="#module-cpl_cli.configuration.settings_helper" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.configuration.settings_helper.SettingsHelper">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.settings_helper.</span></code><code class="sig-name descname"><span class="pre">SettingsHelper</span></code><a class="headerlink" href="#cpl_cli.configuration.settings_helper.SettingsHelper" 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.configuration.settings_helper.SettingsHelper.get_build_settings_dict">
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">get_build_settings_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">build</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em><span class="sig-paren">)</span> &#x2192; <span class="pre">dict</span><a class="headerlink" href="#cpl_cli.configuration.settings_helper.SettingsHelper.get_build_settings_dict" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.settings_helper.SettingsHelper.get_project_settings_dict">
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">get_project_settings_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em><span class="sig-paren">)</span> &#x2192; <span class="pre">dict</span><a class="headerlink" href="#cpl_cli.configuration.settings_helper.SettingsHelper.get_project_settings_dict" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.configuration.version_settings">
<span id="cpl-cli-configuration-version-settings-module"></span><h2>cpl_cli.configuration.version_settings module<a class="headerlink" href="#module-cpl_cli.configuration.version_settings" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.configuration.version_settings.VersionSettings">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.version_settings.</span></code><code class="sig-name descname"><span class="pre">VersionSettings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.configuration.version_settings.VersionSettings" 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.configuration.version_settings.VersionSettings.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.configuration.version_settings.VersionSettings.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.configuration.version_settings.VersionSettings.major">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">major</span></code><a class="headerlink" href="#cpl_cli.configuration.version_settings.VersionSettings.major" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.version_settings.VersionSettings.micro">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">micro</span></code><a class="headerlink" href="#cpl_cli.configuration.version_settings.VersionSettings.micro" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.version_settings.VersionSettings.minor">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">minor</span></code><a class="headerlink" href="#cpl_cli.configuration.version_settings.VersionSettings.minor" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.version_settings.VersionSettings.to_dict">
<code class="sig-name descname"><span class="pre">to_dict</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <span class="pre">dict</span><a class="headerlink" href="#cpl_cli.configuration.version_settings.VersionSettings.to_dict" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.version_settings.VersionSettings.to_str">
<code class="sig-name descname"><span class="pre">to_str</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <span class="pre">str</span><a class="headerlink" href="#cpl_cli.configuration.version_settings.VersionSettings.to_str" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.configuration.version_settings_name_enum">
<span id="cpl-cli-configuration-version-settings-name-enum-module"></span><h2>cpl_cli.configuration.version_settings_name_enum module<a class="headerlink" href="#module-cpl_cli.configuration.version_settings_name_enum" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.version_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">VersionSettingsNameEnum</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.configuration.version_settings_name_enum.VersionSettingsNameEnum" 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.configuration.version_settings_name_enum.VersionSettingsNameEnum.major">
<code class="sig-name descname"><span class="pre">major</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Major'</span></em><a class="headerlink" href="#cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum.major" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum.micro">
<code class="sig-name descname"><span class="pre">micro</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Micro'</span></em><a class="headerlink" href="#cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum.micro" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum.minor">
<code class="sig-name descname"><span class="pre">minor</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Minor'</span></em><a class="headerlink" href="#cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum.minor" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.configuration.workspace_settings">
<span id="cpl-cli-configuration-workspace-settings-module"></span><h2>cpl_cli.configuration.workspace_settings module<a class="headerlink" href="#module-cpl_cli.configuration.workspace_settings" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.configuration.workspace_settings.WorkspaceSettings">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.workspace_settings.</span></code><code class="sig-name descname"><span class="pre">WorkspaceSettings</span></code><a class="headerlink" href="#cpl_cli.configuration.workspace_settings.WorkspaceSettings" 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.configuration.workspace_settings.WorkspaceSettings.default_project">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">default_project</span></code><a class="headerlink" href="#cpl_cli.configuration.workspace_settings.WorkspaceSettings.default_project" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.configuration.workspace_settings.WorkspaceSettings.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.configuration.workspace_settings.WorkspaceSettings.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.configuration.workspace_settings.WorkspaceSettings.projects">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">projects</span></code><a class="headerlink" href="#cpl_cli.configuration.workspace_settings.WorkspaceSettings.projects" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.configuration.workspace_settings_name_enum">
<span id="cpl-cli-configuration-workspace-settings-name-enum-module"></span><h2>cpl_cli.configuration.workspace_settings_name_enum module<a class="headerlink" href="#module-cpl_cli.configuration.workspace_settings_name_enum" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.configuration.workspace_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">WorkspaceSettingsNameEnum</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.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum" 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.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum.default_project">
<code class="sig-name descname"><span class="pre">default_project</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'DefaultProject'</span></em><a class="headerlink" href="#cpl_cli.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum.default_project" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="cpl_cli.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum.projects">
<code class="sig-name descname"><span class="pre">projects</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Projects'</span></em><a class="headerlink" href="#cpl_cli.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum.projects" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_cli.live_server.html" class="btn btn-neutral float-right" title="cpl_cli.live_server" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.command.html" class="btn btn-neutral float-left" title="cpl_cli.command" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; 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>

519
docs/build/html/cpl_cli.html vendored Normal file
View File

@ -0,0 +1,519 @@
<!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 &mdash; 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> &raquo;</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> &#x2192; <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> &#x2192; <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>
&#169; 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>

283
docs/build/html/cpl_cli.live_server.html vendored Normal file
View File

@ -0,0 +1,283 @@
<!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.live_server &mdash; 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.publish" href="cpl_cli.publish.html" />
<link rel="prev" title="cpl_cli.configuration" href="cpl_cli.configuration.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="reference internal" href="cpl_cli.html">CPL_CLI</a><ul class="current">
<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 current"><a class="current reference internal" href="#">cpl_cli.live_server</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.live_server.live_server_service">cpl_cli.live_server.live_server_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.live_server.live_server_thread">cpl_cli.live_server.live_server_thread module</a></li>
</ul>
</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="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a></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> &raquo;</li>
<li><a href="cpl_cli.html">CPL_CLI</a> &raquo;</li>
<li>cpl_cli.live_server</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.live_server.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-live-server">
<h1>cpl_cli.live_server<a class="headerlink" href="#cpl-cli-live-server" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl_cli.live_server.live_server_service">
<span id="cpl-cli-live-server-live-server-service-module"></span><h2>cpl_cli.live_server.live_server_service module<a class="headerlink" href="#module-cpl_cli.live_server.live_server_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.live_server.live_server_service.LiveServerService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.live_server.live_server_service.</span></code><code class="sig-name descname"><span class="pre">LiveServerService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_service.LiveServerService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">watchdog.events.FileSystemEventHandler</span></code></p>
<dl class="py method">
<dt id="cpl_cli.live_server.live_server_service.LiveServerService.on_modified">
<code class="sig-name descname"><span class="pre">on_modified</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_service.LiveServerService.on_modified" title="Permalink to this definition"></a></dt>
<dd><p>Triggers when source file is modified
:param event:
:return:</p>
</dd></dl>
<dl class="py method">
<dt id="cpl_cli.live_server.live_server_service.LiveServerService.start">
<code class="sig-name descname"><span class="pre">start</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.live_server.live_server_service.LiveServerService.start" title="Permalink to this definition"></a></dt>
<dd><p>Starts the CPL live development server
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.live_server.live_server_thread">
<span id="cpl-cli-live-server-live-server-thread-module"></span><h2>cpl_cli.live_server.live_server_thread module<a class="headerlink" href="#module-cpl_cli.live_server.live_server_thread" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.live_server.live_server_thread.</span></code><code class="sig-name descname"><span class="pre">LiveServerThread</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">executable</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">path</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>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_thread.LiveServerThread" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">threading.Thread</span></code></p>
<dl class="py method">
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread.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.live_server.live_server_thread.LiveServerThread.command" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread.main">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">main</span></code><a class="headerlink" href="#cpl_cli.live_server.live_server_thread.LiveServerThread.main" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread.run">
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_thread.LiveServerThread.run" title="Permalink to this definition"></a></dt>
<dd><p>Starts the CPL project
:return:</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_cli.publish.html" class="btn btn-neutral float-right" title="cpl_cli.publish" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.configuration.html" class="btn btn-neutral float-left" title="cpl_cli.configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; 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>

331
docs/build/html/cpl_cli.publish.html vendored Normal file
View File

@ -0,0 +1,331 @@
<!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.publish &mdash; 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.source_creator" href="cpl_cli.source_creator.html" />
<link rel="prev" title="cpl_cli.live_server" href="cpl_cli.live_server.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="reference internal" href="cpl_cli.html">CPL_CLI</a><ul class="current">
<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 current"><a class="current reference internal" href="#">cpl_cli.publish</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.publish.publisher_abc">cpl_cli.publish.publisher_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.publish.publisher_service">cpl_cli.publish.publisher_service module</a></li>
</ul>
</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="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a></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> &raquo;</li>
<li><a href="cpl_cli.html">CPL_CLI</a> &raquo;</li>
<li>cpl_cli.publish</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.publish.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-publish">
<h1>cpl_cli.publish<a class="headerlink" href="#cpl-cli-publish" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl_cli.publish.publisher_abc">
<span id="cpl-cli-publish-publisher-abc-module"></span><h2>cpl_cli.publish.publisher_abc module<a class="headerlink" href="#module-cpl_cli.publish.publisher_abc" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.publish.publisher_abc.PublisherABC">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.publish.publisher_abc.</span></code><code class="sig-name descname"><span class="pre">PublisherABC</span></code><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC" 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.publish.publisher_abc.PublisherABC.build">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC.build" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.publish.publisher_abc.PublisherABC.dist_path">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">dist_path</span></code><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC.dist_path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.publish.publisher_abc.PublisherABC.exclude">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">exclude</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</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.publish.publisher_abc.PublisherABC.exclude" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.publish.publisher_abc.PublisherABC.include">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">include</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</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.publish.publisher_abc.PublisherABC.include" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.publish.publisher_abc.PublisherABC.publish">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">publish</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC.publish" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.publish.publisher_abc.PublisherABC.source_path">
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">source_path</span></code><a class="headerlink" href="#cpl_cli.publish.publisher_abc.PublisherABC.source_path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.publish.publisher_service">
<span id="cpl-cli-publish-publisher-service-module"></span><h2>cpl_cli.publish.publisher_service module<a class="headerlink" href="#module-cpl_cli.publish.publisher_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.publish.publisher_service.PublisherService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.publish.publisher_service.</span></code><code class="sig-name descname"><span class="pre">PublisherService</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">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_cli.publish.publisher_abc.PublisherABC" title="cpl_cli.publish.publisher_abc.PublisherABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_cli.publish.publisher_abc.PublisherABC</span></code></a></p>
<dl class="py method">
<dt id="cpl_cli.publish.publisher_service.PublisherService.build">
<code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService.build" title="Permalink to this definition"></a></dt>
<dd><p>Build the CPL project to dist_path/build</p>
<ol class="arabic simple">
<li><p>Reads all included source files</p></li>
<li><p>Writes informations from template to all included __init__.py</p></li>
</ol>
<p>3. Copies all included source files to dist_path/build
:return:</p>
</dd></dl>
<dl class="py method">
<dt id="cpl_cli.publish.publisher_service.PublisherService.dist_path">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">dist_path</span></code><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService.dist_path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.publish.publisher_service.PublisherService.exclude">
<code class="sig-name descname"><span class="pre">exclude</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</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.publish.publisher_service.PublisherService.exclude" title="Permalink to this definition"></a></dt>
<dd><p>Excludes given path from sources
:param path:
:return:</p>
</dd></dl>
<dl class="py method">
<dt id="cpl_cli.publish.publisher_service.PublisherService.include">
<code class="sig-name descname"><span class="pre">include</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</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.publish.publisher_service.PublisherService.include" title="Permalink to this definition"></a></dt>
<dd><p>Includes given path from sources
:param path:
:return:</p>
</dd></dl>
<dl class="py method">
<dt id="cpl_cli.publish.publisher_service.PublisherService.publish">
<code class="sig-name descname"><span class="pre">publish</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService.publish" title="Permalink to this definition"></a></dt>
<dd><p>Publishes the CPL project to dist_path/publish</p>
<ol class="arabic simple">
<li><p>Builds the project</p></li>
<li><p>Generates setup.py</p></li>
<li><p>Start setup.py</p></li>
</ol>
<p>4. Remove all included source from dist_path/publish
:return:</p>
</dd></dl>
<dl class="py method">
<dt id="cpl_cli.publish.publisher_service.PublisherService.source_path">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">source_path</span></code><a class="headerlink" href="#cpl_cli.publish.publisher_service.PublisherService.source_path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_cli.source_creator.html" class="btn btn-neutral float-right" title="cpl_cli.source_creator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.live_server.html" class="btn btn-neutral float-left" title="cpl_cli.live_server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; 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>

View File

@ -0,0 +1,295 @@
<!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.source_creator &mdash; 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="prev" title="cpl_cli.publish" href="cpl_cli.publish.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="reference internal" href="cpl_cli.html">CPL_CLI</a><ul class="current">
<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 current"><a class="current reference internal" href="#">cpl_cli.source_creator</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.source_creator.console_builder">cpl_cli.source_creator.console_builder module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.source_creator.library_builder">cpl_cli.source_creator.library_builder module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.source_creator.template_builder">cpl_cli.source_creator.template_builder module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a></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> &raquo;</li>
<li><a href="cpl_cli.html">CPL_CLI</a> &raquo;</li>
<li>cpl_cli.source_creator</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.source_creator.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-source-creator">
<h1>cpl_cli.source_creator<a class="headerlink" href="#cpl-cli-source-creator" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl_cli.source_creator.console_builder">
<span id="cpl-cli-source-creator-console-builder-module"></span><h2>cpl_cli.source_creator.console_builder module<a class="headerlink" href="#module-cpl_cli.source_creator.console_builder" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.source_creator.console_builder.ConsoleBuilder">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.source_creator.console_builder.</span></code><code class="sig-name descname"><span class="pre">ConsoleBuilder</span></code><a class="headerlink" href="#cpl_cli.source_creator.console_builder.ConsoleBuilder" 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.source_creator.console_builder.ConsoleBuilder.build">
<em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_path</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">use_application_api</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">use_startup</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">use_service_providing</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">project_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">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workspace</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.workspace_settings.WorkspaceSettings" title="cpl_cli.configuration.workspace_settings.WorkspaceSettings"><span class="pre">cpl_cli.configuration.workspace_settings.WorkspaceSettings</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.source_creator.console_builder.ConsoleBuilder.build" title="Permalink to this definition"></a></dt>
<dd><p>Builds the console project files
:param project_path:
:param use_application_api:
:param use_startup:
:param use_service_providing:
:param project_name:
:param project_settings:
:param workspace:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.source_creator.library_builder">
<span id="cpl-cli-source-creator-library-builder-module"></span><h2>cpl_cli.source_creator.library_builder module<a class="headerlink" href="#module-cpl_cli.source_creator.library_builder" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.source_creator.library_builder.LibraryBuilder">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.source_creator.library_builder.</span></code><code class="sig-name descname"><span class="pre">LibraryBuilder</span></code><a class="headerlink" href="#cpl_cli.source_creator.library_builder.LibraryBuilder" 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.source_creator.library_builder.LibraryBuilder.build">
<em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_path</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">use_application_api</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">use_startup</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">use_service_providing</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">project_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">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workspace</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.workspace_settings.WorkspaceSettings" title="cpl_cli.configuration.workspace_settings.WorkspaceSettings"><span class="pre">cpl_cli.configuration.workspace_settings.WorkspaceSettings</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.source_creator.library_builder.LibraryBuilder.build" title="Permalink to this definition"></a></dt>
<dd><p>Builds the library project files
:param project_path:
:param use_application_api:
:param use_startup:
:param use_service_providing:
:param project_name:
:param project_settings:
:param workspace:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.source_creator.template_builder">
<span id="cpl-cli-source-creator-template-builder-module"></span><h2>cpl_cli.source_creator.template_builder module<a class="headerlink" href="#module-cpl_cli.source_creator.template_builder" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.source_creator.template_builder.TemplateBuilder">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.source_creator.template_builder.</span></code><code class="sig-name descname"><span class="pre">TemplateBuilder</span></code><a class="headerlink" href="#cpl_cli.source_creator.template_builder.TemplateBuilder" 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.source_creator.template_builder.TemplateBuilder.build">
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">project_path</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">template</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">cpl_cli._templates.template_file_abc.TemplateFileABC</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.source_creator.template_builder.TemplateBuilder.build" title="Permalink to this definition"></a></dt>
<dd><p>Creates template
:param project_path:
:param template:
:return:</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_cli.publish.html" class="btn btn-neutral float-left" title="cpl_cli.publish" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; 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>

File diff suppressed because it is too large Load Diff

View File

@ -85,6 +85,7 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>
@ -162,6 +163,7 @@
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>
</div> </div>
</div> </div>

View File

@ -84,6 +84,7 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>
@ -244,6 +245,66 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a><ul>
<li class="toctree-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l2"><a class="reference internal" href="cpl_cli.configuration.html">cpl_cli.configuration</a><ul>
<li class="toctree-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l3"><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-l2"><a class="reference internal" href="cpl_cli.live_server.html">cpl_cli.live_server</a><ul>
<li class="toctree-l3"><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-l3"><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-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl_cli.publish</a><ul>
<li class="toctree-l3"><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-l3"><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-l2"><a class="reference internal" href="cpl_cli.source_creator.html">cpl_cli.source_creator</a><ul>
<li class="toctree-l3"><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-l3"><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-l3"><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>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.html#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> </ul>
</div> </div>
</div> </div>

Binary file not shown.

View File

@ -87,6 +87,7 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>
@ -154,7 +155,8 @@
<h1>Python Module Index</h1> <h1>Python Module Index</h1>
<div class="modindex-jumpbox"> <div class="modindex-jumpbox">
<a href="#cap-c"><strong>c</strong></a> <a href="#cap-c"><strong>c</strong></a> |
<a href="#cap-t"><strong>t</strong></a>
</div> </div>
<table class="indextable modindextable"> <table class="indextable modindextable">
@ -392,6 +394,210 @@
<td>&#160;&#160;&#160; <td>&#160;&#160;&#160;
<a href="cpl.utils.html#module-cpl.utils.string"><code class="xref">cpl.utils.string</code></a></td><td> <a href="cpl.utils.html#module-cpl.utils.string"><code class="xref">cpl.utils.string</code></a></td><td>
<em></em></td></tr> <em></em></td></tr>
<tr>
<td><img src="_static/minus.png" class="toggler"
id="toggle-2" style="display: none" alt="-" /></td>
<td>
<a href="cpl_cli.html#module-cpl_cli"><code class="xref">cpl_cli</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.html#module-cpl_cli.cli"><code class="xref">cpl_cli.cli</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.html#module-cpl_cli.cli_settings"><code class="xref">cpl_cli.cli_settings</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum"><code class="xref">cpl_cli.cli_settings_name_enum</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.add_service"><code class="xref">cpl_cli.command.add_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.build_service"><code class="xref">cpl_cli.command.build_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.generate_service"><code class="xref">cpl_cli.command.generate_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.help_service"><code class="xref">cpl_cli.command.help_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.install_service"><code class="xref">cpl_cli.command.install_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.new_service"><code class="xref">cpl_cli.command.new_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.publish_service"><code class="xref">cpl_cli.command.publish_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.remove_service"><code class="xref">cpl_cli.command.remove_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.start_service"><code class="xref">cpl_cli.command.start_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.uninstall_service"><code class="xref">cpl_cli.command.uninstall_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.update_service"><code class="xref">cpl_cli.command.update_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.command.html#module-cpl_cli.command.version_service"><code class="xref">cpl_cli.command.version_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.html#module-cpl_cli.command_abc"><code class="xref">cpl_cli.command_abc</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.html#module-cpl_cli.command_handler_service"><code class="xref">cpl_cli.command_handler_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.html#module-cpl_cli.command_model"><code class="xref">cpl_cli.command_model</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.build_settings"><code class="xref">cpl_cli.configuration.build_settings</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.build_settings_name_enum"><code class="xref">cpl_cli.configuration.build_settings_name_enum</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_settings"><code class="xref">cpl_cli.configuration.project_settings</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_settings_name_enum"><code class="xref">cpl_cli.configuration.project_settings_name_enum</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.project_type_enum"><code class="xref">cpl_cli.configuration.project_type_enum</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.settings_helper"><code class="xref">cpl_cli.configuration.settings_helper</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.version_settings"><code class="xref">cpl_cli.configuration.version_settings</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.version_settings_name_enum"><code class="xref">cpl_cli.configuration.version_settings_name_enum</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.workspace_settings"><code class="xref">cpl_cli.configuration.workspace_settings</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.configuration.html#module-cpl_cli.configuration.workspace_settings_name_enum"><code class="xref">cpl_cli.configuration.workspace_settings_name_enum</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.html#module-cpl_cli.error"><code class="xref">cpl_cli.error</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.live_server.html#module-cpl_cli.live_server.live_server_service"><code class="xref">cpl_cli.live_server.live_server_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.live_server.html#module-cpl_cli.live_server.live_server_thread"><code class="xref">cpl_cli.live_server.live_server_thread</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.html#module-cpl_cli.main"><code class="xref">cpl_cli.main</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.publish.html#module-cpl_cli.publish.publisher_abc"><code class="xref">cpl_cli.publish.publisher_abc</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.publish.html#module-cpl_cli.publish.publisher_service"><code class="xref">cpl_cli.publish.publisher_service</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.console_builder"><code class="xref">cpl_cli.source_creator.console_builder</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.library_builder"><code class="xref">cpl_cli.source_creator.library_builder</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.source_creator.html#module-cpl_cli.source_creator.template_builder"><code class="xref">cpl_cli.source_creator.template_builder</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="cpl_cli.html#module-cpl_cli.startup"><code class="xref">cpl_cli.startup</code></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-t"><td></td><td>
<strong>t</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="tests.html#module-tests"><code class="xref">tests</code></a></td><td>
<em></em></td></tr>
</table> </table>

View File

@ -87,6 +87,7 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li> <li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul> </ul>

File diff suppressed because one or more lines are too long

244
docs/build/html/tests.html vendored Normal file
View File

@ -0,0 +1,244 @@
<!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>tests package &mdash; 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" />
</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>
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></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> &raquo;</li>
<li>tests package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tests.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="tests-package">
<h1>tests package<a class="headerlink" href="#tests-package" title="Permalink to this headline"></a></h1>
<div class="section" id="module-tests">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-tests" title="Permalink to this headline"></a></h2>
<div class="section" id="sh-cpl-sh-edraft-common-python-library">
<h3>sh_cpl sh-edraft Common Python library<a class="headerlink" href="#sh-cpl-sh-edraft-common-python-library" title="Permalink to this headline"></a></h3>
<p>sh-edraft Common Python library</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="tests.VersionInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">tests.</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="#tests.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="tests.VersionInfo.major">
<code class="sig-name descname"><span class="pre">major</span></code><a class="headerlink" href="#tests.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="tests.VersionInfo.micro">
<code class="sig-name descname"><span class="pre">micro</span></code><a class="headerlink" href="#tests.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="tests.VersionInfo.minor">
<code class="sig-name descname"><span class="pre">minor</span></code><a class="headerlink" href="#tests.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>
<hr/>
<div role="contentinfo">
<p>
&#169; 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>

View File

@ -15,7 +15,7 @@
# sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
import os import os
import sys import sys
sys.path.insert(0, os.path.abspath('../../src/cpl')) sys.path.insert(0, os.path.abspath('../../src'))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
@ -41,7 +41,10 @@ templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path. # This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [] exclude_patterns = [
'cpl_cli/templates/*',
'tests/*'
]
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------

View File

@ -0,0 +1,98 @@
cpl\_cli.command
========================
cpl\_cli.command.add\_service module
------------------------------------
.. automodule:: cpl_cli.command.add_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.build\_service module
--------------------------------------
.. automodule:: cpl_cli.command.build_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.generate\_service module
-----------------------------------------
.. automodule:: cpl_cli.command.generate_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.help\_service module
-------------------------------------
.. automodule:: cpl_cli.command.help_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.install\_service module
----------------------------------------
.. automodule:: cpl_cli.command.install_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.new\_service module
------------------------------------
.. automodule:: cpl_cli.command.new_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.publish\_service module
----------------------------------------
.. automodule:: cpl_cli.command.publish_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.remove\_service module
---------------------------------------
.. automodule:: cpl_cli.command.remove_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.start\_service module
--------------------------------------
.. automodule:: cpl_cli.command.start_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.uninstall\_service module
------------------------------------------
.. automodule:: cpl_cli.command.uninstall_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.update\_service module
---------------------------------------
.. automodule:: cpl_cli.command.update_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.version\_service module
----------------------------------------
.. automodule:: cpl_cli.command.version_service
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,82 @@
cpl\_cli.configuration
==============================
cpl\_cli.configuration.build\_settings module
---------------------------------------------
.. automodule:: cpl_cli.configuration.build_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.build\_settings\_name\_enum module
---------------------------------------------------------
.. automodule:: cpl_cli.configuration.build_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.project\_settings module
-----------------------------------------------
.. automodule:: cpl_cli.configuration.project_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.project\_settings\_name\_enum module
-----------------------------------------------------------
.. automodule:: cpl_cli.configuration.project_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.project\_type\_enum module
-------------------------------------------------
.. automodule:: cpl_cli.configuration.project_type_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.settings\_helper module
----------------------------------------------
.. automodule:: cpl_cli.configuration.settings_helper
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.version\_settings module
-----------------------------------------------
.. automodule:: cpl_cli.configuration.version_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.version\_settings\_name\_enum module
-----------------------------------------------------------
.. automodule:: cpl_cli.configuration.version_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.workspace\_settings module
-------------------------------------------------
.. automodule:: cpl_cli.configuration.workspace_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.workspace\_settings\_name\_enum module
-------------------------------------------------------------
.. automodule:: cpl_cli.configuration.workspace_settings_name_enum
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,18 @@
cpl\_cli.live\_server
=============================
cpl\_cli.live\_server.live\_server\_service module
--------------------------------------------------
.. automodule:: cpl_cli.live_server.live_server_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.live\_server.live\_server\_thread module
-------------------------------------------------
.. automodule:: cpl_cli.live_server.live_server_thread
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,18 @@
cpl\_cli.publish
========================
cpl\_cli.publish.publisher\_abc module
--------------------------------------
.. automodule:: cpl_cli.publish.publisher_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.publish.publisher\_service module
------------------------------------------
.. automodule:: cpl_cli.publish.publisher_service
:members:
:undoc-members:
:show-inheritance:

92
docs/source/cpl_cli.rst Normal file
View File

@ -0,0 +1,92 @@
CPL_CLI
================
.. toctree::
:maxdepth: 4
cpl_cli.command
cpl_cli.configuration
cpl_cli.live_server
cpl_cli.publish
cpl_cli.source_creator
cpl_cli.templates
cpl\_cli.cli
-------------------
.. automodule:: cpl_cli.cli
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.cli\_settings
-----------------------------
.. automodule:: cpl_cli.cli_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.cli\_settings\_name\_enum
-----------------------------------------
.. automodule:: cpl_cli.cli_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command\_abc
----------------------------
.. automodule:: cpl_cli.command_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command\_handler\_service
-----------------------------------------
.. automodule:: cpl_cli.command_handler_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command\_model
------------------------------
.. automodule:: cpl_cli.command_model
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.error
---------------------
.. automodule:: cpl_cli.error
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.main
--------------------
.. automodule:: cpl_cli.main
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.startup
-----------------------
.. automodule:: cpl_cli.startup
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_cli
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,26 @@
cpl\_cli.source\_creator
================================
cpl\_cli.source\_creator.console\_builder module
------------------------------------------------
.. automodule:: cpl_cli.source_creator.console_builder
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.source\_creator.library\_builder module
------------------------------------------------
.. automodule:: cpl_cli.source_creator.library_builder
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.source\_creator.template\_builder module
-------------------------------------------------
.. automodule:: cpl_cli.source_creator.template_builder
:members:
:undoc-members:
:show-inheritance:

View File

@ -2,6 +2,7 @@ cpl
=== ===
.. toctree:: .. toctree::
:maxdepth: 4 :maxdepth: 4
cpl cpl
cpl_cli

View File

@ -11,7 +11,7 @@ sh-edraft Common Python library Command Line Interface
""" """
__title__ = 'cpl_cli.templates' __title__ = 'cpl_cli._templates'
__author__ = 'Sven Heidemann' __author__ = 'Sven Heidemann'
__license__ = 'MIT' __license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'

View File

@ -11,7 +11,7 @@ sh-edraft Common Python library Command Line Interface
""" """
__title__ = 'cpl_cli.templates.build' __title__ = 'cpl_cli._templates.build'
__author__ = 'Sven Heidemann' __author__ = 'Sven Heidemann'
__license__ = 'MIT' __license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'

View File

@ -0,0 +1,25 @@
# -*- coding: utf-8 -*-
"""
sh_cpl-cli sh-edraft Common Python library CLI
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Command Line Interface
:copyright: (c) 2020 - 2021 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_cli._templates.generate'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'
__version__ = '2021.4'
from collections import namedtuple
# imports:
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2021', minor='4', micro='None')

View File

@ -2,7 +2,7 @@ import textwrap
from string import Template from string import Template
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class ABCTemplate(TemplateFileABC): class ABCTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import textwrap
from string import Template from string import Template
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class ClassTemplate(TemplateFileABC): class ClassTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import textwrap
from string import Template from string import Template
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class ConfigModelTemplate(TemplateFileABC): class ConfigModelTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import textwrap
from string import Template from string import Template
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class EnumTemplate(TemplateFileABC): class EnumTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import textwrap
from string import Template from string import Template
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class InitTemplate(TemplateFileABC): class InitTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import textwrap
from string import Template from string import Template
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class ServiceTemplate(TemplateFileABC): class ServiceTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import textwrap
from string import Template from string import Template
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class ThreadTemplate(TemplateFileABC): class ThreadTemplate(TemplateFileABC):

View File

@ -11,7 +11,7 @@ sh-edraft Common Python library Command Line Interface
""" """
__title__ = 'cpl_cli.templates.new' __title__ = 'cpl_cli._templates.new'
__author__ = 'Sven Heidemann' __author__ = 'Sven Heidemann'
__license__ = 'MIT' __license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de' __copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'

View File

@ -0,0 +1,25 @@
# -*- coding: utf-8 -*-
"""
sh_cpl-cli sh-edraft Common Python library CLI
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Command Line Interface
:copyright: (c) 2020 - 2021 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_cli._templates.new.console'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'
__version__ = '2021.4'
from collections import namedtuple
# imports:
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2021', minor='4', micro='None')

View File

@ -1,6 +1,6 @@
import textwrap import textwrap
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class AppsettingsTemplate(TemplateFileABC): class AppsettingsTemplate(TemplateFileABC):

View File

@ -1,4 +1,4 @@
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class LicenseTemplate(TemplateFileABC): class LicenseTemplate(TemplateFileABC):

View File

@ -1,4 +1,4 @@
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class ReadmeTemplate(TemplateFileABC): class ReadmeTemplate(TemplateFileABC):

View File

@ -0,0 +1,25 @@
# -*- coding: utf-8 -*-
"""
sh_cpl-cli sh-edraft Common Python library CLI
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Command Line Interface
:copyright: (c) 2020 - 2021 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_cli._templates.new.console.source'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'
__version__ = '2021.4'
from collections import namedtuple
# imports:
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2021', minor='4', micro='None')

View File

@ -0,0 +1,25 @@
# -*- coding: utf-8 -*-
"""
sh_cpl-cli sh-edraft Common Python library CLI
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Command Line Interface
:copyright: (c) 2020 - 2021 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_cli._templates.new.console.source.name'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'
__version__ = '2021.4'
from collections import namedtuple
# imports:
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2021', minor='4', micro='None')

View File

@ -2,7 +2,7 @@ import os.path
import textwrap import textwrap
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class ApplicationTemplate(TemplateFileABC): class ApplicationTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import os.path
import textwrap import textwrap
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class MainInitTemplate(TemplateFileABC): class MainInitTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import os.path
import textwrap import textwrap
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class MainWithApplicationHostAndStartupTemplate(TemplateFileABC): class MainWithApplicationHostAndStartupTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import os.path
import textwrap import textwrap
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class StartupTemplate(TemplateFileABC): class StartupTemplate(TemplateFileABC):

View File

@ -1,6 +1,6 @@
import textwrap import textwrap
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class TestsInitTemplate(TemplateFileABC): class TestsInitTemplate(TemplateFileABC):

View File

@ -0,0 +1,25 @@
# -*- coding: utf-8 -*-
"""
sh_cpl-cli sh-edraft Common Python library CLI
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Command Line Interface
:copyright: (c) 2020 - 2021 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_cli._templates.new.library'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'
__version__ = '2021.4'
from collections import namedtuple
# imports:
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2021', minor='4', micro='None')

View File

@ -1,6 +1,6 @@
import textwrap import textwrap
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class AppsettingsTemplate(TemplateFileABC): class AppsettingsTemplate(TemplateFileABC):

View File

@ -1,4 +1,4 @@
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class LicenseTemplate(TemplateFileABC): class LicenseTemplate(TemplateFileABC):

View File

@ -1,4 +1,4 @@
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class ReadmeTemplate(TemplateFileABC): class ReadmeTemplate(TemplateFileABC):

View File

@ -0,0 +1,25 @@
# -*- coding: utf-8 -*-
"""
sh_cpl-cli sh-edraft Common Python library CLI
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Command Line Interface
:copyright: (c) 2020 - 2021 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_cli._templates.new.library.source'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'
__version__ = '2021.4'
from collections import namedtuple
# imports:
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2021', minor='4', micro='None')

View File

@ -0,0 +1,25 @@
# -*- coding: utf-8 -*-
"""
sh_cpl-cli sh-edraft Common Python library CLI
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library Command Line Interface
:copyright: (c) 2020 - 2021 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_cli._templates.new.library.source.name'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'
__version__ = '2021.4'
from collections import namedtuple
# imports:
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2021', minor='4', micro='None')

View File

@ -2,7 +2,7 @@ import os
import textwrap import textwrap
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class ApplicationTemplate(TemplateFileABC): class ApplicationTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import os
import textwrap import textwrap
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class NameInitTemplate(TemplateFileABC): class NameInitTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import os.path
import textwrap import textwrap
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class MainWithApplicationHostAndStartupTemplate(TemplateFileABC): class MainWithApplicationHostAndStartupTemplate(TemplateFileABC):

View File

@ -2,7 +2,7 @@ import os
import textwrap import textwrap
from cpl.utils.string import String from cpl.utils.string import String
from cpl_cli.templates.template_file_abc import TemplateFileABC from cpl_cli._templates.template_file_abc import TemplateFileABC
class StartupTemplate(TemplateFileABC): class StartupTemplate(TemplateFileABC):

Some files were not shown because too many files have changed in this diff Show More