2021-04-14 10:45:39 +02:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
2023-04-05 21:43:21 +02:00
< meta charset = "utf-8" / > < meta name = "generator" content = "Docutils 0.19: https://docutils.sourceforge.io/" / >
2022-06-27 21:42:34 +02:00
2021-04-14 10:45:39 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< title > Introduction to the CPL Docs — Common Python Library documentation< / title >
2022-06-27 21:42:34 +02:00
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
2021-04-14 10:45:39 +02:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
< script src = "_static/jquery.js" > < / script >
2022-06-27 21:42:34 +02:00
< script src = "_static/_sphinx_javascript_frameworks_compat.js" > < / script >
2023-04-05 21:43:21 +02:00
< script data-url_root = "./" id = "documentation_options" src = "_static/documentation_options.js" > < / script >
2021-04-14 10:45:39 +02:00
< script src = "_static/doctools.js" > < / script >
2023-04-05 21:43:21 +02:00
< script src = "_static/sphinx_highlight.js" > < / script >
2022-06-27 21:42:34 +02:00
< script src = "_static/js/theme.js" > < / script >
2021-04-14 10:45:39 +02:00
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
2021-05-17 18:32:09 +02:00
< link rel = "next" title = "Introduction to the CPL Docs" href = "introduction.html" / >
2021-04-14 10:45:39 +02:00
< / head >
2022-06-27 21:42:34 +02:00
< body class = "wy-body-for-nav" >
2021-04-14 10:45:39 +02:00
< 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" >
2023-04-05 21:43:21 +02:00
< a href = "#" class = "icon icon-home" >
Common Python Library
2021-04-14 10:45:39 +02:00
< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
2023-04-05 21:43:21 +02:00
< input type = "text" name = "q" placeholder = "Search docs" aria-label = "Search docs" / >
2021-04-14 10:45:39 +02:00
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
2022-06-27 21:42:34 +02:00
< / div > < div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "Navigation menu" >
2021-04-14 10:45:39 +02:00
< ul >
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 >
2022-07-31 11:30:05 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "contributing.html" > Contributing to CPL< / a > < / li >
2023-04-05 21:43:21 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "deprecated.html" > Deprecated< / a > < / li >
2022-12-04 00:50:24 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_cli.html" > CLI reference< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_core.html" > API reference< / a > < / li >
2023-04-04 13:16:19 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_discord.html" > Discord Reference< / a > < / li >
2022-12-04 00:50:24 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_query.html" > Query reference< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_translation.html" > Translation reference< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / div >
< / div >
< / nav >
2022-06-27 21:42:34 +02:00
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" > < nav class = "wy-nav-top" aria-label = "Mobile navigation menu" >
2021-04-14 10:45:39 +02:00
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "#" > Common Python Library< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
2022-06-27 21:42:34 +02:00
< div role = "navigation" aria-label = "Page navigation" >
2021-04-14 10:45:39 +02:00
< ul class = "wy-breadcrumbs" >
2023-04-05 21:43:21 +02:00
< li > < a href = "#" class = "icon icon-home" aria-label = "Home" > < / a > < / li >
< li class = "breadcrumb-item active" > Introduction to the CPL Docs< / li >
2021-04-14 10:45:39 +02:00
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/index.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" >
2022-06-27 21:42:34 +02:00
< section id = "introduction-to-the-cpl-docs" >
< h1 > Introduction to the CPL Docs< a class = "headerlink" href = "#introduction-to-the-cpl-docs" title = "Permalink to this heading" > < / a > < / h1 >
2021-04-14 10:45:39 +02:00
< p > The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications.< / p >
< p > This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises.< / p >
2022-07-31 11:30:05 +02:00
< section id = "features" >
< h2 > Features< a class = "headerlink" href = "#features" title = "Permalink to this heading" > < / a > < / h2 >
< ul class = "simple" >
< li > < dl class = "simple" >
< dt > cpl-core< / dt > < dd > < ul >
2023-04-05 21:43:21 +02:00
< li > < p > Expandable< / p > < / li >
2022-07-31 11:30:05 +02:00
< li > < dl class = "simple" >
< dt > Application base< / dt > < dd > < ul >
< li > < p > Standardized application classes< / p > < / li >
< li > < p > Application object builder< / p > < / li >
< li > < p > Application extension classes< / p > < / li >
< li > < p > Startup classes< / p > < / li >
< li > < p > Startup extension classes< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > Configuration< / dt > < dd > < ul >
< li > < p > Configure via object mapped JSON< / p > < / li >
< li > < p > Console argument handling< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > Console class for in and output< / dt > < dd > < ul >
< li > < p > Banner< / p > < / li >
< li > < p > Spinner< / p > < / li >
< li > < p > Options (menu)< / p > < / li >
< li > < p > Table< / p > < / li >
< li > < p > Write< / p > < / li >
< li > < p > Write_at< / p > < / li >
< li > < p > Write_line< / p > < / li >
< li > < p > Write_line_at< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > Dependency injection< / dt > < dd > < ul >
< li > < p > Service lifetimes: singleton, scoped and transient< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > Providing of application environment< / dt > < dd > < ul >
< li > < p > Environment (development, staging, testing, production)< / p > < / li >
< li > < p > Appname< / p > < / li >
< li > < p > Customer< / p > < / li >
< li > < p > Hostname< / p > < / li >
< li > < p > Runtime directory< / p > < / li >
< li > < p > Working directory< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > Logging< / dt > < dd > < ul >
< li > < p > Standardized logger< / p > < / li >
< li > < p > Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE)< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > Mail handling< / dt > < dd > < ul >
< li > < p > Send mails< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > Pipe classes< / dt > < dd > < ul >
< li > < p > Convert input< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > Utils< / dt > < dd > < ul >
< li > < dl class = "simple" >
< dt > Credential manager< / dt > < dd > < ul >
< li > < p > Encryption via BASE64< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > PIP wrapper class based on subprocess< / dt > < dd > < ul >
< li > < p > Run pip commands< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > String converter to different variants< / dt > < dd > < ul >
< li > < p > to_lower_case< / p > < / li >
< li > < p > to_camel_case< / p > < / li >
< li > < p > …< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< / ul >
< / dd >
< / dl >
< / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > cpl-cli< / dt > < dd > < ul >
< li > < p > Expandle< / p > < / li >
< li > < p > Code generation< / p > < / li >
< li > < p > Package managing< / p > < / li >
< li > < p > Build & Publishing< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > cpl-discord< / dt > < dd > < ul >
< li > < p > Utils for discord.py< / p > < / li >
< li > < p > Connector between cpl-core and discord.py< / p > < / li >
< li > < p > Prepared services for dependency injection< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > cpl-query< / dt > < dd > < ul >
< li > < p > Python list extensions< / p > < / li >
< li > < p > Functions for sorting and filtering< / p > < / li >
< li > < p > Like linq from C# but in python xD< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > cpl-translate< / dt > < dd > < ul >
< li > < p > Generic translations< / p > < / li >
< li > < p > Prepared translation service and translate pipe< / p > < / li >
< li > < p > Get translation from JSON files key dot.key notation< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< / ul >
< / section >
2022-06-27 21:42:34 +02:00
< section id = "manuals" >
< h2 > Manuals< a class = "headerlink" href = "#manuals" title = "Permalink to this heading" > < / a > < / h2 >
2021-04-14 10:45:39 +02:00
< p > These pages go into great detail about everything the Library can do.< / p >
< div class = "toctree-wrapper compound" >
< ul >
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 >
2022-07-31 11:30:05 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "contributing.html" > Contributing to CPL< / a > < / li >
2023-04-05 21:43:21 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "deprecated.html" > Deprecated< / a > < / li >
2022-12-04 00:50:24 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_cli.html" > CLI reference< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_core.html" > API reference< / a > < / li >
2023-04-04 13:16:19 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_discord.html" > Discord Reference< / a > < / li >
2022-12-04 00:50:24 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_query.html" > Query reference< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_translation.html" > Translation reference< / a > < / li >
2021-04-14 10:45:39 +02:00
< / ul >
< / div >
2022-06-27 21:42:34 +02:00
< / section >
< / section >
2021-04-14 10:45:39 +02:00
< / div >
< / div >
2022-06-27 21:42:34 +02:00
< footer > < div class = "rst-footer-buttons" role = "navigation" aria-label = "Footer" >
2021-05-17 18:32:09 +02:00
< a href = "introduction.html" class = "btn btn-neutral float-right" title = "Introduction to the CPL Docs" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
2021-04-14 10:45:39 +02:00
< / div >
< hr / >
< div role = "contentinfo" >
2022-12-04 00:50:24 +01:00
< p > © Copyright 2021 - 2023, Sven Heidemann.< / p >
2021-12-02 08:20:38 +01:00
< / div >
2022-06-27 21:42:34 +02:00
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
2021-04-14 10:45:39 +02:00
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
2022-06-27 21:42:34 +02:00
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
2021-04-14 10:45:39 +02:00
< / footer >
< / div >
< / div >
< / section >
< / div >
2022-06-27 21:42:34 +02:00
< script >
2021-04-14 10:45:39 +02:00
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
2022-06-27 21:42:34 +02:00
< / script >
2021-04-14 10:45:39 +02:00
< / body >
< / html >
