2021-04-14 10:45:39 +02:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2021-05-17 18:32:09 +02:00
< title > API Reference — Common Python Library documentation< / title >
2021-04-14 10:45:39 +02:00
< 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" / >
2021-05-17 18:32:09 +02:00
< link rel = "prev" title = "Setting up the local environment and workspace" href = "setup.html" / >
2021-04-14 10:45:39 +02:00
< / 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" >
2021-05-17 18:32:09 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "introduction.html" > Introduction to the CPL Docs< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "getting_started.html" > Getting started< / a > < / li >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > API Reference< / a > < ul >
2021-04-14 10:45:39 +02:00
< 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 >
< / ul >
< / li >
2021-05-17 18:32:09 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_cli.html" > CLI Reference< / a > < / li >
2021-04-14 10:45:39 +02:00
< / 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 >
2021-05-17 18:32:09 +02:00
< li > API Reference< / li >
2021-04-14 10:45:39 +02:00
< 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" >
2021-05-17 18:32:09 +02:00
< div class = "section" id = "api-reference" >
< h1 > API Reference< a class = "headerlink" href = "#api-reference" title = "Permalink to this headline" > ¶< / a > < / h1 >
2021-04-14 10:45:39 +02:00
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl.application.html" > cpl.application< / a > < ul >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.application.html#module-cpl.application.application_abc" > cpl.application.application_abc< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.application.html#module-cpl.application.application_builder" > cpl.application.application_builder< / 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< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.application.html#module-cpl.application.startup_abc" > cpl.application.startup_abc< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl.configuration.html" > cpl.configuration< / a > < ul >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.configuration.html#module-cpl.configuration.configuration" > cpl.configuration.configuration< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.configuration.html#module-cpl.configuration.configuration_abc" > cpl.configuration.configuration_abc< / 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< / 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< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.configuration.html#module-cpl.configuration.console_argument" > cpl.configuration.console_argument< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl.console.html" > cpl.console< / a > < ul >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.console.html#module-cpl.console.background_color_enum" > cpl.console.background_color_enum< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.console.html#module-cpl.console.console" > cpl.console.console< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.console.html#module-cpl.console.console_call" > cpl.console.console_call< / 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< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.console.html#module-cpl.console.spinner_thread" > cpl.console.spinner_thread< / a > < / li >
2021-04-14 10:45:39 +02:00
< / 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 >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l3" > < a class = "reference internal" href = "cpl.database.connection.html#module-cpl.database.connection.database_connection" > cpl.database.connection.database_connection< / 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< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.database.context.html" > cpl.database.context< / a > < ul >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l3" > < a class = "reference internal" href = "cpl.database.context.html#module-cpl.database.context.database_context" > cpl.database.context.database_context< / 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< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.database.html#submodules" > Submodules< / a > < / li >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.database.html#module-cpl.database.database_model" > cpl.database.database_model< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.database.html#module-cpl.database.database_settings" > cpl.database.database_settings< / 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< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl.dependency_injection.html" > cpl.dependency_injection< / a > < ul >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection" > cpl.dependency_injection.service_collection< / 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< / 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< / 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< / 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< / 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< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl.environment.html" > cpl.environment< / a > < ul >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.environment.html#module-cpl.environment.application_environment" > cpl.environment.application_environment< / 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< / 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< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl.logging.html" > cpl.logging< / a > < ul >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.logging.html#module-cpl.logging.logger_abc" > cpl.logging.logger_abc< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.logging.html#module-cpl.logging.logger_service" > cpl.logging.logger_service< / 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< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.logging.html#module-cpl.logging.logging_settings" > cpl.logging.logging_settings< / 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< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl.mailing.html" > cpl.mailing< / a > < ul >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.mailing.html#module-cpl.mailing.email" > cpl.mailing.email< / 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< / 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< / 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< / 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< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl.time.html" > cpl.time< / a > < ul >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.time.html#module-cpl.time.time_format_settings" > cpl.time.time_format_settings< / 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< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl.utils.html" > cpl.utils< / a > < ul >
2021-04-14 22:20:18 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.utils.html#module-cpl.utils.credential_manager" > cpl.utils.credential_manager< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.utils.html#module-cpl.utils.pip" > cpl.utils.pip< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cpl.utils.html#module-cpl.utils.string" > cpl.utils.string< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / li >
< / ul >
< / 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 >
2021-05-17 18:32:09 +02:00
< a href = "setup.html" class = "btn btn-neutral float-left" title = "Setting up the local environment and workspace" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
2021-04-14 10:45:39 +02:00
< / 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 >
