352 lines
17 KiB
HTML
352 lines
17 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
|
|
<title>CPL — 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.application" href="cpl.application.html" />
|
|
<link rel="prev" title="Introduction to the CPL Docs" href="index.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 current"><a class="current reference internal" href="#">CPL</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#module-cpl">Module contents</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#sh-cpl-sh-edraft-common-python-library">sh_cpl sh-edraft Common Python library</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</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> »</li>
|
|
|
|
<li>CPL</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="_sources/cpl.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">
|
|
<h1>CPL<a class="headerlink" href="#cpl" title="Permalink to this headline">¶</a></h1>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl.application.html">cpl.application</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_abc">cpl.application.application_abc module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder">cpl.application.application_builder module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder_abc">cpl.application.application_builder_abc module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.startup_abc">cpl.application.startup_abc module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration">cpl.configuration.configuration module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_abc">cpl.configuration.configuration_abc module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_model_abc">cpl.configuration.configuration_model_abc module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_variable_name_enum">cpl.configuration.configuration_variable_name_enum module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.console_argument">cpl.configuration.console_argument module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl.console.html">cpl.console</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.background_color_enum">cpl.console.background_color_enum module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.console">cpl.console.console module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.console_call">cpl.console.console_call module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.foreground_color_enum">cpl.console.foreground_color_enum module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.spinner_thread">cpl.console.spinner_thread module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl.database.html">cpl.database</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.database.connection.html">cpl.database.connection</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.database.context.html">cpl.database.context</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context">cpl.database.context.database_context module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html#submodules">Submodules</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection">cpl.dependency_injection.service_collection module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection_abc">cpl.dependency_injection.service_collection_abc module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_descriptor">cpl.dependency_injection.service_descriptor module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_lifetime_enum">cpl.dependency_injection.service_lifetime_enum module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider">cpl.dependency_injection.service_provider module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider_abc">cpl.dependency_injection.service_provider_abc module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl.environment.html">cpl.environment</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment">cpl.environment.application_environment module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment_abc">cpl.environment.application_environment_abc module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.environment_name_enum">cpl.environment.environment_name_enum module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl.logging.html">cpl.logging</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_abc">cpl.logging.logger_abc module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_service">cpl.logging.logger_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_level_enum">cpl.logging.logging_level_enum module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings">cpl.logging.logging_settings module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings_name_enum">cpl.logging.logging_settings_name_enum module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email">cpl.mailing.email module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_abc">cpl.mailing.email_client_abc module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_service">cpl.mailing.email_client_service module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings">cpl.mailing.email_client_settings module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings_name_enum">cpl.mailing.email_client_settings_name_enum module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl.time.html">cpl.time</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings">cpl.time.time_format_settings module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings_names_enum">cpl.time.time_format_settings_names_enum module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl.utils.html">cpl.utils</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.credential_manager">cpl.utils.credential_manager module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.pip">cpl.utils.pip module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.string">cpl.utils.string module</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="module-cpl">
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl" 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="cpl.VersionInfo">
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.</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.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.VersionInfo.major">
|
|
<code class="sig-name descname"><span class="pre">major</span></code><a class="headerlink" href="#cpl.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.VersionInfo.micro">
|
|
<code class="sig-name descname"><span class="pre">micro</span></code><a class="headerlink" href="#cpl.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.VersionInfo.minor">
|
|
<code class="sig-name descname"><span class="pre">minor</span></code><a class="headerlink" href="#cpl.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.application.html" class="btn btn-neutral float-right" title="cpl.application" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
<a href="index.html" class="btn btn-neutral float-left" title="Introduction to the CPL Docs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2021, Sven Heidemann.
|
|
|
|
</p>
|
|
</div>
|
|
|
|
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |