Merge pull request 'Added structured and wrapped logger #187' (#193) from #187_structured_logging into dev

Reviewed-on: #193

.gitea/workflows/build-dev.yaml

@@ -12,6 +12,27 @@ jobs:
       version_suffix: 'dev'
     secrets: inherit
 
+  api:
+    uses: ./.gitea/workflows/package.yaml
+    needs: [ prepare, application, auth, core, dependency ]
+    with:
+      working_directory: src/cpl-api
+    secrets: inherit
+
+  application:
+    uses: ./.gitea/workflows/package.yaml
+    needs: [ prepare, core, dependency ]
+    with:
+      working_directory: src/cpl-application
+    secrets: inherit
+
+  auth:
+    uses: ./.gitea/workflows/package.yaml
+    needs: [ prepare, core, dependency,  database ]
+    with:
+      working_directory: src/cpl-auth
+    secrets: inherit
+
   core:
     uses: ./.gitea/workflows/package.yaml
     needs: [prepare]
@@ -19,6 +40,27 @@ jobs:
       working_directory: src/cpl-core
     secrets: inherit
 
+  database:
+    uses: ./.gitea/workflows/package.yaml
+    needs: [ prepare, core, dependency ]
+    with:
+      working_directory: src/cpl-database
+    secrets: inherit
+
+  dependency:
+    uses: ./.gitea/workflows/package.yaml
+    needs: [ prepare, core ]
+    with:
+      working_directory: src/cpl-dependency
+    secrets: inherit
+
+  mail:
+    uses: ./.gitea/workflows/package.yaml
+    needs: [ prepare, core, dependency ]
+    with:
+      working_directory: src/cpl-mail
+    secrets: inherit
+
   query:
     uses: ./.gitea/workflows/package.yaml
     needs: [prepare]
@@ -28,14 +70,7 @@ jobs:
 
   translation:
     uses: ./.gitea/workflows/package.yaml
-    needs: [ prepare, core ]
+    needs: [ prepare, core, dependency ]
     with:
       working_directory: src/cpl-translation
-    secrets: inherit
-
-  mail:
-    uses: ./.gitea/workflows/package.yaml
-    needs: [ prepare, core ]
-    with:
-      working_directory: src/cpl-mail
     secrets: inherit

.gitea/workflows/test_before_merge.yaml

@@ -0,0 +1,26 @@
+name: Test before pr merge
+run-name: Test before pr merge
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - reopened
+      - synchronize
+      - ready_for_review
+
+jobs:
+  test-lint:
+    runs-on: [ runner ]
+    container: git.sh-edraft.de/sh-edraft.de/act-runner:latest
+    steps:
+      - name: Clone Repository
+        uses: https://github.com/actions/checkout@v3
+        with:
+          token: ${{ secrets.CI_ACCESS_TOKEN }}
+
+      - name: Installing black
+        run: python3.12 -m pip install black
+
+      - name: Checking black
+        run: python3.12 -m black src --check

.gitignore

@@ -113,6 +113,7 @@ venv.bak/
 
 # Custom Environments
 cpl-env/
+.secret
 
 # Spyder project settings
 .spyderproject
@@ -138,3 +139,6 @@ PythonImportHelper-v2-Completion.json
 
 # cpl unittest stuff
 unittests/test_*_playground
+
+# cpl logs
+**/logs/*.jsonl

README.md

@@ -1,153 +0,0 @@
-<h1 align="center">CPL - Common python library</h1>
-
-<!-- Summary -->
-<p align="center">
-  <!-- <img src="" alt="cpl-logo" width="120px" height="120px"/> -->
-  <br>
-  <i>
-  CPL is a development platform for python server applications
-  <br>using Python.</i>
-  <br>
-</p>
-
-## Table of Contents
-<!-- TABLE OF CONTENTS -->
-<ol>
-   <li><a href="#Features">Features</a></li>
-   <li>
-     <a href="#getting-started">Getting Started</a>
-     <ul>
-       <li><a href="#prerequisites">Prerequisites</a></li>
-       <li><a href="#installation">Installation</a></li>
-     </ul>
-   </li>
-   <li><a href="#roadmap">Roadmap</a></li>
-   <li><a href="#contributing">Contributing</a></li>
-   <li><a href="#license">License</a></li>
-   <li><a href="#contact">Contact</a></li>
-</ol>
-
-## Features
-<!-- FEATURE OVERVIEW -->
-- Expandle
-- Application base
-    - Standardized application classes
-    - Application object builder
-    - Application extension classes
-    - Startup classes
-    - Startup extension classes
-- Configuration
-    - Configure via object mapped JSON
-    - Console argument handling
-- Console class for in and output
-    - Banner
-    - Spinner
-    - Options (menu)
-    - Table
-    - Write
-    - Write_at
-    - Write_line
-    - Write_line_at
-- Dependency injection
-    - Service lifetimes: singleton, scoped and transient
-- Providing of application environment
-    - Environment (development, staging, testing, production)
-    - Appname
-    - Customer
-    - Hostname
-    - Runtime directory
-    - Working directory
-- Logging
-    - Standardized logger
-    - Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE)
-- Mail handling
-    - Send mails
-- Pipe classes
-    - Convert input
-- Utils
-    - Credential manager
-        - Encryption via BASE64
-    - PIP wrapper class based on subprocess
-        - Run pip commands
-    - String converter to different variants
-        - to_lower_case
-        - to_camel_case
-        - ...
-
-<!-- GETTING STARTED -->
-## Getting Started
-
-[Get started with CPL][quickstart].
-
-### Prerequisites
-
-- Install [python] which includes [Pip installs packages][pip]
-
-### Installation
-
-Install the CPL package
-```sh
-pip install cpl-core --extra-index-url https://pip.sh-edraft.de
-```
-
-Install the CPL CLI
-```sh
-pip install cpl-cli --extra-index-url https://pip.sh-edraft.de
-```
-
-Create workspace:
-```sh
-cpl new <console|library|unittest> <PROJECT NAME>
-```
-
-Run the application:
-```sh
-cd <PROJECT NAME>
-cpl start
-```
-
-
-<!-- ROADMAP -->
-## Roadmap
-
-See the [open issues](https://git.sh-edraft.de/sh-edraft.de/sh_cpl/issues) for a list of proposed features (and known issues).
-
-
-
-<!-- CONTRIBUTING -->
-## Contributing
-
-### Contributing Guidelines
-
-Read through our [contributing guidelines][contributing] to learn about our submission process, coding rules and more.
-
-### Want to Help?
-
-Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing][contributing].
-
-
-
-<!-- LICENSE -->
-## License
-
-Distributed under the MIT License. See [LICENSE] for more information.
-
-
-
-<!-- CONTACT -->
-## Contact
-
-Sven Heidemann - sven.heidemann@sh-edraft.de
-
-Project link: [https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib](https://git.sh-edraft.de/sh-edraft.de/sh_cpl)
-
-<!-- External LINKS -->
-[pip_url]: https://pip.sh-edraft.de
-[python]: https://www.python.org/
-[pip]: https://pypi.org/project/pip/
-
-<!-- Internal LINKS -->
-[project]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl
-[quickstart]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/wiki/quickstart
-[contributing]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/wiki/contributing
-[license]: LICENSE

docs/Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build/html/.buildinfo

@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 7161cd79d6fb56140ef1c390e01dab1c
-tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/contributing.md.txt

@@ -1,111 +0,0 @@
-# Contributing to CPL
-
-We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:
-
-- [Issuses and Bugs](#found-a-bug)
-- [Feature Request](#feature-request)
-- [Submission Guidelines](#submission-guidelines)
-- [Coding Rules](#coding-rules)
-- [License](#license)
-
-## Found a Bug?
-
-If you find a bug in the source code, you can help us by [submitting an issue](#submitting-an-issue) to our [Gitea Repository][gitea-repo]. Even better, you can [submit a Pull Request](#submitting-a-pull-request) with a fix.
-
-## Feature Request
-
-You can request a new feature by submitting an issue to our [Gitea Repository][gitea-repo]. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:
-
-For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
-
-Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.
-
-Small Features can be crafted and directly submitted as a [Pull Request](#submit-pr).
-
-## Submission Guidelines
-
-### Submitting an Issue
-
-Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
-
-We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.
-
-A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.
-
-We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it.
-
-Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced.
-
-### Submitting a Pull Request
-
-Before you submit your Pull Request (PR) consider the following guidelines:
-
-1. Search the [repository][gitea-repo] for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.
-
-2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.
-
-3. Fork the sh-edraft.de/cpl repo.
-
-4. In your forked repository, make your changes in a new git branch:
-
-    ```sh
-    git checkout -b my-fix-branch master
-    ```
-
-5. Create your patch, including appropriate test cases.
-
-<!-- 6. Follow our [Coding Rules](coding-rules). -->
-
-6. Commit your changes.
-
-    ```sh
-    git commit --all
-    ```
-
-    Note: the optional commit ```-a``` command line option will automatically "add" and "rm" edited files.
-
-7. Push your branch to the [repository][gitea-repo]:
-
-    ```sh
-    git push origin my-fix-branch
-    ```
-
-8. In Gitea, send a pull request to cpl:master
-
-### Reviewing a Pull Request
-
-The sh-edraft.de team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following the CPL [coding rules](#coding-rules) and applies within or outside of CPL managed channels.
-
-#### Addressing review feedback
-
-If we ask for changes via code reviews then:
-
-1. Make the required updates to the code.
-
-2. Create a fixup commit and push to your repository (this will update your Pull Request):
-
-    ```sh
-    git commit --all --fixup HEAD
-    git push
-    ```
-
-That's it! Thank you for your contribution!
-
-## Coding Rules
-
-To ensure consistency throughout the source code, keep these rules in mind as you are working:
-
-- All features or bug fixes must be tested by one or more unit-tests.
-
-- All public API methods must be documented.
-
-- We follow [PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/).
-
-## License
-
-By contributing, you agree that your contributions will be licensed under its MIT License.
-See [LICENSE](https://git.sh-edraft.de/sh-edraft.de/cpl/src/branch/master/LICENSE)
-
-<!-- LINKS -->
-[gitea-repo]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/
-[coding-rules]: /

docs/build/html/_sources/cpl_cli.add.md.txt

@@ -1,32 +0,0 @@
-# cpl add
-
-## Contents
-
-- [Description](#description)
-- [Arguments](#arguments)
-- [Flags](#flags)
-
-Removes a project from workspace.
-
-cpl **add** *&lt;source-project&gt;* *&lt;target-project&gt;* <br>
-cpl **a** *&lt;source-project&gt;* *&lt;target-project&gt;* <br>
-cpl **A** *&lt;source-project&gt;* *&lt;target-project&gt;*
-
-## Description
-
-Adds a project reference to given project.
-
-If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.
-
-## Arguments
-
-| Argument               |                        Description                         | Value type |
-|------------------------|:----------------------------------------------------------:|:----------:|
-| ```<source-project>``` | Name of the project to which the reference has to be added | ```str```  |
-| ```<target-project>``` |            Name of the project to be referenced            | ```str```  |
-
-## Flags
-
-| Argument         |                Description                 |
-|------------------|:------------------------------------------:|
-| ```--simulate``` | Specifies whether the command is simulated |

docs/build/html/_sources/cpl_cli.build.md.txt

@@ -1,26 +0,0 @@
-# cpl build
-
-## Contents
-
-- [Description](#description)
-<!-- - [Arguments](#arguments) -->
-
-Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory
-
-cpl **build** <br>
-cpl **b** <br>
-cpl **B**
-
-## Description
-
-The command can be used to build a project of type "console" or "library".
-
-The build command copies all included source files to the output directory. You can run the source files in the output directory directly.
-
-The command is used to prepare the source files for the publish command or to copy them to an target for execution.
-
-<!-- ## Arguments
-
-| Argument      | Description   | Value type      |
-| ------------- |:-------------:|:----------------:|
-| ```<project>```     | The name of the project to build. Can be an console or a library. | ```str``` -->

docs/build/html/_sources/cpl_cli.generate.md.txt

@@ -1,43 +0,0 @@
-# cpl generate
-
-## Contents
-
-- [Description](#description)
-- [Arguments](#arguments)
-- [Schematics](#schematics)
-
-Generate a file based on schematic.
-
-cpl **generate** *&lt;schematic&gt;* *&lt;name&gt;* <br>
-cpl **g** *&lt;schematic&gt;* *&lt;name&gt;* <br>
-cpl **G** *&lt;schematic&gt;* *&lt;name&gt;*
-
-## Description
-
-Generates files based on a schematic.
-
-You can define custom schematics by creating templates in a ```.cpl``` folder.
-
-## Arguments
-
-| Argument          |                                                                             Description                                                                             | Value type    |
-|-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------:|
-| ```<schematic>``` |                                                                     The schematic to generate.                                                                      | ```str```     |
-| ```<name>```      |                                                                   The name of the generated file.                                                                   | ```str```     |
-| ```--base```      | First element of path will be used as base-path not 'src'. For example: 'cpl g c test/Test' will be created at ```src/test/``` with --base it would be ```test/```  | ```str```     |
-
-## Schematics
-
-| Schematic       |              Description               |  Arguments   |
-|-----------------|:--------------------------------------:|:------------:|
-| ```abc```       |          Abstract base class           | ```<name>``` |
-| ```class```     |                 Class                  | ```<name>``` |
-| ```enum```      |               Enum class               | ```<name>``` |
-| ```pipe```      |               Pipe class               | ```<name>``` |
-| ```service```   |             Service class              | ```<name>``` |
-| ```settings```  | [Configmodel](cpl.core.configuration)  | ```<name>``` |
-| ```test```      |               Test class               | ```<name>``` |
-| ```thread```    |              Thread class              | ```<name>``` |
-| ```validator``` |            Validator class             | ```<name>``` |
-| ```command```   |       Discord bot command class        | ```<name>``` |
-| ```event```     |        Discord bot event class         | ```<name>``` |

docs/build/html/_sources/cpl_cli.help.md.txt

@@ -1,22 +0,0 @@
-# cpl help
-
-## Contents
-
-- [Description](#description)
-- [Arguments](#arguments)
-
-Lists available command and their short descriptions.
-
-cpl **help** *&lt;command&gt;* <br>
-cpl **h** *&lt;command&gt;* <br>
-cpl **H** *&lt;command&gt;*
-
-## Description
-
-Lists available command and their short descriptions.
-
-## Arguments
-
-| Argument          | Description                   | Value type    |
-| ----------------- |:-----------------------------:|:-------------:|
-| ```<command>```   | Shows a help message for this command in the console.   | ```str```     |

docs/build/html/_sources/cpl_cli.install.md.txt

@@ -1,31 +0,0 @@
-# cpl install
-
-## Contents
-
-- [Description](#description)
-- [Arguments](#arguments)
-
-Installs given package via pip
-
-cpl **install** *&lt;package&gt;* <br>
-cpl **i** *&lt;package&gt;* <br>
-cpl **I** *&lt;package&gt;*
-
-## Description
-
-Install given package to project via pip.
-Without given package it will install the depedencies of the CPL project your in.
-
-## Arguments
-
-| Argument        |      Description       | Value type |
-|-----------------|:----------------------:|:----------:|
-| ```<package>``` | The package to install | ```str```  |
-
-## Flags
-
-| Argument         |                     Description                      |
-|------------------|:----------------------------------------------------:|
-| ```--dev```      | Specifies whether the command is in development mode |
-| ```--virtual```  |    Specifies whether the command is virtual mode     |
-| ```--simulate``` |      Specifies whether the command is simulated      |

docs/build/html/_sources/cpl_cli.new.md.txt

@@ -1,45 +0,0 @@
-# cpl new
-
-## Contents
-
-- [Description](#description)
-- [Arguments](#arguments)
-- [Project types](#project-types)
-
-Generates a workspace and initial project or add a project to workspace.
-
-cpl **new** *&lt;type&gt;* *&lt;name&gt;*<br>
-cpl **n** *&lt;type&gt;* *&lt;name&gt;* <br>
-cpl **N** *&lt;type&gt;* *&lt;name&gt;*
-
-## Description
-
-Generates a workspace and initial project or add a project to workspace.
-
-You can define custom project types by creating templates in a ```.cpl``` folder.
-
-If the command is running in a CPL workspace, it will add the new project to the workspace.
-
-| Argument     |                                                                            Description                                                                             | Value type |
-|--------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------:|
-| ```<type>``` |                                                        The type of the project, see [types](#project-types)                                                        | ```str```  |
-| ```<name>``` |                                                                      The name of the project                                                                       | ```str```  |
-| ```--base``` | First element of path will be used as base-path not 'src'. For example: 'cpl g c test/Test' will be created at ```src/test/``` with --base it would be ```test/``` | ```str```     |
-
-## Project types
-
-| Project type  |         Description          |
-|---------------|:----------------------------:|
-| ```console``` | A simple console application |
-| ```library``` |          A package           |
-
-## Flags
-
-| Argument                  |                 Description                 |
-|---------------------------|:-------------------------------------------:|
-| ```--async```             |       Specifies whether async is used       |
-| ```--application-base```  | Specifies whether application base is used  |
-| ```--startup```           |      Specifies whether startup is used      |
-| ```--service-providing``` | Specifies whether service-providing is used |
-| ```--nothing```           |      Specifies whether nothing is used      |
-| ```--venv```              |       Specifies whether venv is used        |

docs/build/html/_sources/cpl_cli.overview.md.txt

@@ -1,53 +0,0 @@
-# CLI Overview and Command Reference
-
-## Table of Contents
-
-1. [Install CPL](setup#install-the-package)
-2. [Install CPL CLI](setup#install-the-cli)
-3. [Basic workflow](#basic-workflow)
-4. [CLI command-language syntax](#cli-command-language-syntax)
-5. [Command overview](#command-overview)
-
-## Basic workflow
-
-To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands:
-
-```sh
-cpl new console my-first-project
-cd my-first-project
-cpl start
-```
-
-In the terminal you will the output of the app.
-
-## CLI command-language syntax
-
-```cpl``` commandNameOrAlias requiredArg ```[optionalsArgs]```
-
-- Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command.
-- Arguments are not prefixed.
-
-### Relative paths
-
-Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root.
-
-### Schematics
-
-The cpl generate command takes as an argument the artifact to be generated.  In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options.
-
-## Command overview
-
-| Command                       | Alias         | Description      |
-| ----------------------------- |:-------------:|:----------------:|
-| [add](cpl_cli.add)               | a or a        | Adds a project reference to given project.
-| [build](cpl_cli.build)            | b or B        | Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.
-| [generate](cpl_cli.generate)      | g or G        | Generate a new file.
-| [help](cpl_cli.help)              | h or H        | Lists available command and their short descriptions.
-| [install](cpl_cli.install)        | i or I        | With argument installs packages to project, without argument installs project dependencies.
-| [new](cpl_cli.new)                | n or N        | Creates new CPL project.
-| [publish](cpl_cli.publish)        | p or P        | Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. Must be executed from within a library workspace directory.
-| [remove](cpl_cli.remove)          | r or R        | Removes a project from workspace.
-| [start](cpl_cli.start)            | s or S        | Starts CPL project, restarting on file changes.
-| [uninstall](cpl_cli.uninstall)    | ui or UI      | Uninstalls packages from project.
-| [update](cpl_cli.update)          | u or U        | Update CPL and project dependencies.
-| [version](cpl_cli.version)        | v or V        | Outputs CPL CLI version.

docs/build/html/_sources/cpl_cli.publish.md.txt

@@ -1,27 +0,0 @@
-# cpl publish
-
-## Contents
-
-- [Description](#description)
-<!-- - [Arguments](#arguments) -->
-
-Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```.
-
-cpl **publish** <br>
-cpl **p** <br>
-cpl **P**
-
-## Description
-
-The command can be used to publish a project of type "console" or "library".
-
-The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.core.json```.
-The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory.
-
-Generated files of ```setup.py``` are in the 'publish/setup/' directory.
-
-<!-- ## Arguments
-
-| Argument      | Description   | Value type      |
-| ------------- |:-------------:|:----------------:|
-| ```<project>```     | The name of the project to build. Can be an console or a library. | ```str``` -->

docs/build/html/_sources/cpl_cli.remove.md.txt

@@ -1,30 +0,0 @@
-# cpl remove
-
-## Contents
-
-- [Description](#description)
-- [Arguments](#arguments)
-
-Removes a project from workspace.
-
-cpl **remove** *&lt;project&gt;* <br>
-cpl **r** *&lt;project&gt;* <br>
-cpl **R** *&lt;project&gt;*
-
-## Description
-
-Removes a project reference and the files from workspace.
-
-If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.
-
-## Arguments
-
-| Argument        |            Description            | Value type |
-|-----------------|:---------------------------------:|:----------:|
-| ```<project>``` | The name of the project to delete | ```str```  |
-
-## Flags
-
-| Argument         |                     Description                      |
-|------------------|:----------------------------------------------------:|
-| ```--simulate``` |      Specifies whether the command is simulated      |

docs/build/html/_sources/cpl_cli.rst.txt

@@ -1,20 +0,0 @@
-CLI reference
-=============
-
-.. toctree::
-    :maxdepth: 4
-
-    cpl_cli.overview
-    cpl_cli.add
-    cpl_cli.build
-    cpl_cli.generate
-    cpl_cli.help
-    cpl_cli.install
-    cpl_cli.new
-    cpl_cli.publish
-    cpl_cli.remove
-    cpl_cli.run
-    cpl_cli.start
-    cpl_cli.uninstall
-    cpl_cli.update
-    cpl_cli.version

docs/build/html/_sources/cpl_cli.run.md.txt

@@ -1,12 +0,0 @@
-# cpl run
-
-Starts your application once.
-
-cpl **run** <br>
-cpl **r** <br>
-cpl **R**
-
-| Argument        |                                             Description                                              | Value type |
-|-----------------|:----------------------------------------------------------------------------------------------------:|:----------:|
-| ```<project>``` |  Optional parameter to specify which project to start, if not set default project will be started.   | ```str```  |
-| ```--dev```     |                     To run the project from source and not from dist after build.                    | ```str```  |

docs/build/html/_sources/cpl_cli.start.md.txt

@@ -1,11 +0,0 @@
-# cpl start
-
-Starts your application, restarting on file changes.
-
-cpl **start** <br>
-cpl **s** <br>
-cpl **S**
-
-| Argument        |                                             Description                                              | Value type |
-|-----------------|:----------------------------------------------------------------------------------------------------:|:----------:|
-| ```--dev```     |                     To run the project from source and not from dist after build.                    | ```str```  |

docs/build/html/_sources/cpl_cli.uninstall.md.txt

@@ -1,30 +0,0 @@
-# cpl uninstall
-
-## Contents
-
-- [Description](#description)
-- [Arguments](#arguments)
-
-Uninstalls given package via pip
-
-cpl **uninstall** *&lt;package&gt;* <br>
-cpl **ui** *&lt;package&gt;* <br>
-cpl **UI** *&lt;package&gt;*
-
-## Description
-
-Uninstall given package from project via pip.
-
-## Arguments
-
-| Argument        |       Description        | Value type |
-|-----------------|:------------------------:|:----------:|
-| ```<package>``` | The package to uninstall | ```str```  |
-
-## Flags
-
-| Argument         |                     Description                      |
-|------------------|:----------------------------------------------------:|
-| ```--dev```      | Specifies whether the command is in development mode |
-| ```--virtual```  |    Specifies whether the command is virtual mode     |
-| ```--simulate``` |      Specifies whether the command is simulated      |

docs/build/html/_sources/cpl_cli.update.md.txt

@@ -1,13 +0,0 @@
-# cpl update
-
-Updates the CPL and project dependencies.
-
-cpl **update** <br>
-cpl **u** <br>
-cpl **U**
-
-## Flags
-
-| Argument         |                     Description                      |
-|------------------|:----------------------------------------------------:|
-| ```--simulate``` |      Specifies whether the command is simulated      |

docs/build/html/_sources/cpl_cli.version.md.txt

@@ -1,7 +0,0 @@
-# cpl version
-
-Lists the version of CPL, CPL CLI and all installed packages from pip.
-
-cpl **version** <br>
-cpl **v** <br>
-cpl **V**

docs/build/html/_sources/cpl_core.application.rst.txt

@@ -1,61 +0,0 @@
-cpl\_core.application package
-=============================
-
-Submodules
-----------
-
-cpl\_core.application.application\_abc module
----------------------------------------------
-
-.. automodule:: cpl.core.application.application_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.application.application\_builder module
--------------------------------------------------
-
-.. automodule:: cpl.core.application.application_builder
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.application.application\_builder\_abc module
-------------------------------------------------------
-
-.. automodule:: cpl.core.application.application_builder_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.application.application\_extension\_abc module
---------------------------------------------------------
-
-.. automodule:: cpl.core.application.application_extension_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.application.startup\_abc module
------------------------------------------
-
-.. automodule:: cpl.core.application.startup_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.application.startup\_extension\_abc module
-----------------------------------------------------
-
-.. automodule:: cpl.core.application.startup_extension_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.core.application
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/_sources/cpl_core.configuration.rst.txt

@@ -1,109 +0,0 @@
-cpl\_core.configuration package
-===============================
-
-Submodules
-----------
-
-cpl\_core.configuration.argument\_abc module
---------------------------------------------
-
-.. automodule:: cpl.core.configuration.argument_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.configuration.argument\_builder module
-------------------------------------------------
-
-.. automodule:: cpl.core.configuration.argument_builder
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.configuration.argument\_executable\_abc module
---------------------------------------------------------
-
-.. automodule:: cpl.core.configuration.argument_executable_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.configuration.argument\_type\_enum module
----------------------------------------------------
-
-.. automodule:: cpl.core.configuration.argument_type_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.configuration.configuration module
---------------------------------------------
-
-.. automodule:: cpl.core.configuration.configuration
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.configuration.configuration\_abc module
--------------------------------------------------
-
-.. automodule:: cpl.core.configuration.configuration_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.configuration.configuration\_model\_abc module
---------------------------------------------------------
-
-.. automodule:: cpl.core.configuration.configuration_model_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.configuration.configuration\_variable\_name\_enum module
-------------------------------------------------------------------
-
-.. automodule:: cpl.core.configuration.configuration_variable_name_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.configuration.executable\_argument module
----------------------------------------------------
-
-.. automodule:: cpl.core.configuration.executable_argument
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.configuration.flag\_argument module
----------------------------------------------
-
-.. automodule:: cpl.core.configuration.flag_argument
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.configuration.validator\_abc module
----------------------------------------------
-
-.. automodule:: cpl.core.configuration.validator_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.configuration.variable\_argument module
--------------------------------------------------
-
-.. automodule:: cpl.core.configuration.variable_argument
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.core.configuration
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/_sources/cpl_core.console.rst.txt

@@ -1,53 +0,0 @@
-cpl\_core.console package
-=========================
-
-Submodules
-----------
-
-cpl\_core.console.background\_color\_enum module
-------------------------------------------------
-
-.. automodule:: cpl.core.console.background_color_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.console.console module
---------------------------------
-
-.. automodule:: cpl.core.console.console
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.console.console\_call module
---------------------------------------
-
-.. automodule:: cpl.core.console.console_call
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.console.foreground\_color\_enum module
-------------------------------------------------
-
-.. automodule:: cpl.core.console.foreground_color_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.console.spinner\_thread module
-----------------------------------------
-
-.. automodule:: cpl.core.console.spinner_thread
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.core.console
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/_sources/cpl_core.database.connection.rst.txt

@@ -1,29 +0,0 @@
-cpl\_core.database.connection package
-=====================================
-
-Submodules
-----------
-
-cpl\_core.database.connection.database\_connection module
----------------------------------------------------------
-
-.. automodule:: cpl.core.database.connection.database_connection
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.database.connection.database\_connection\_abc module
---------------------------------------------------------------
-
-.. automodule:: cpl.core.database.connection.database_connection_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.core.database.connection
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/_sources/cpl_core.database.context.rst.txt

@@ -1,29 +0,0 @@
-cpl\_core.database.context package
-==================================
-
-Submodules
-----------
-
-cpl\_core.database.context.database\_context module
----------------------------------------------------
-
-.. automodule:: cpl.core.database.context.database_context
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.database.context.database\_context\_abc module
---------------------------------------------------------
-
-.. automodule:: cpl.core.database.context.database_context_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.core.database.context
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/_sources/cpl_core.database.rst.txt

@@ -1,46 +0,0 @@
-cpl\_core.database package
-==========================
-
-Subpackages
------------
-
-.. toctree::
-   :maxdepth: 4
-
-   cpl.core.database.connection
-   cpl.core.database.context
-
-Submodules
-----------
-
-cpl\_core.database.database\_settings module
---------------------------------------------
-
-.. automodule:: cpl.core.database.database_settings
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.database.database\_settings\_name\_enum module
---------------------------------------------------------
-
-.. automodule:: cpl.core.database.database_settings_name_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.database.table\_abc module
-------------------------------------
-
-.. automodule:: cpl.core.database.table_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.core.database
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/_sources/cpl_core.dependency_injection.rst.txt

@@ -1,85 +0,0 @@
-cpl\_core.dependency\_injection package
-=======================================
-
-Submodules
-----------
-
-cpl\_core.dependency\_injection.scope module
---------------------------------------------
-
-.. automodule:: cpl.core.dependency_injection.scope
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.dependency\_injection.scope\_abc module
--------------------------------------------------
-
-.. automodule:: cpl.core.dependency_injection.scope_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.dependency\_injection.scope\_builder module
------------------------------------------------------
-
-.. automodule:: cpl.core.dependency_injection.scope_builder
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.dependency\_injection.service\_collection module
-----------------------------------------------------------
-
-.. automodule:: cpl.core.dependency_injection.service_collection
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.dependency\_injection.service\_collection\_abc module
----------------------------------------------------------------
-
-.. automodule:: cpl.core.dependency_injection.service_collection_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.dependency\_injection.service\_descriptor module
-----------------------------------------------------------
-
-.. automodule:: cpl.core.dependency_injection.service_descriptor
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.dependency\_injection.service\_lifetime\_enum module
---------------------------------------------------------------
-
-.. automodule:: cpl.core.dependency_injection.service_lifetime_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.dependency\_injection.service\_provider module
---------------------------------------------------------
-
-.. automodule:: cpl.core.dependency_injection.service_provider
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.dependency\_injection.service\_provider\_abc module
--------------------------------------------------------------
-
-.. automodule:: cpl.core.dependency_injection.service_provider_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.core.dependency_injection
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/_sources/cpl_core.environment.rst.txt

@@ -1,37 +0,0 @@
-cpl\_core.environment package
-=============================
-
-Submodules
-----------
-
-cpl\_core.environment.application\_environment module
------------------------------------------------------
-
-.. automodule:: cpl.core.environment.application_environment
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.environment.application\_environment\_abc module
-----------------------------------------------------------
-
-.. automodule:: cpl.core.environment.application_environment_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.environment.environment\_name\_enum module
-----------------------------------------------------
-
-.. automodule:: cpl.core.environment.environment_name_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.core.environment
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/_sources/cpl_core.logging.rst.txt

@@ -1,53 +0,0 @@
-cpl\_core.logging package
-=========================
-
-Submodules
-----------
-
-cpl\_core.logging.logger\_abc module
-------------------------------------
-
-.. automodule:: cpl.core.log.logger_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.logging.logger\_service module
-----------------------------------------
-
-.. automodule:: cpl.core.log.logger_service
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.logging.logging\_level\_enum module
----------------------------------------------
-
-.. automodule:: cpl.core.log.logging_level_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.logging.logging\_settings module
-------------------------------------------
-
-.. automodule:: cpl.core.log.logging_settings
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.logging.logging\_settings\_name\_enum module
-------------------------------------------------------
-
-.. automodule:: cpl.core.log.logging_settings_name_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.core.log
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/_sources/cpl_core.mailing.rst.txt

@@ -1,53 +0,0 @@
-cpl\_core.mailing package
-=========================
-
-Submodules
-----------
-
-cpl\_core.mailing.email module
-------------------------------
-
-.. automodule:: cpl.mail.email
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.mailing.email\_client\_abc module
--------------------------------------------
-
-.. automodule:: cpl.mail.email_client_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.mailing.email\_client\_service module
------------------------------------------------
-
-.. automodule:: cpl.mail.email_client_service
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.mailing.email\_client\_settings module
-------------------------------------------------
-
-.. automodule:: cpl.mail.email_client_settings
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.mailing.email\_client\_settings\_name\_enum module
-------------------------------------------------------------
-
-.. automodule:: cpl.mail.email_client_settings_name_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.mail
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/_sources/cpl_core.pipes.rst.txt

@@ -1,77 +0,0 @@
-cpl\_core.pipes package
-=======================
-
-Submodules
-----------
-
-cpl\_core.pipes.bool\_pipe module
----------------------------------
-
-.. automodule:: cpl.core.pipes.bool_pipe
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.pipes.first\_char\_to\_lower\_pipe module
----------------------------------------------------
-
-.. automodule:: cpl.core.pipes.first_char_to_lower_pipe
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.pipes.first\_to\_upper\_pipe module
----------------------------------------------
-
-.. automodule:: cpl.core.pipes.first_to_upper_pipe
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.pipes.ip\_address\_pipe module
-----------------------------------------
-
-.. automodule:: cpl.core.pipes.ip_address_pipe
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.pipes.pipe\_abc module
---------------------------------
-
-.. automodule:: cpl.core.pipes.pipe_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.pipes.to\_camel\_case\_pipe module
---------------------------------------------
-
-.. automodule:: cpl.core.pipes.to_camel_case_pipe
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.pipes.to\_snake\_case\_pipe module
---------------------------------------------
-
-.. automodule:: cpl.core.pipes.to_snake_case_pipe
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.pipes.version\_pipe module
-------------------------------------
-
-.. automodule:: cpl.core.pipes.version_pipe
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.core.pipes
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/_sources/cpl_core.rst.txt

@@ -1,18 +0,0 @@
-API reference
-=============
-
-.. toctree::
-    :maxdepth: 4
-
-    cpl.core.application
-    cpl.core.configuration
-    cpl.core.console
-    cpl.core.database
-    cpl.core.dependency_injection
-    cpl.core.environment
-    cpl.core.log
-    cpl.mail
-    cpl.core.pipes
-    cpl.core.time
-    cpl.core.utils
-

docs/build/html/_sources/cpl_core.time.rst.txt

@@ -1,29 +0,0 @@
-cpl\_core.time package
-======================
-
-Submodules
-----------
-
-cpl\_core.time.time\_format\_settings module
---------------------------------------------
-
-.. automodule:: cpl.core.time.time_format_settings
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl\_core.time.time\_format\_settings\_names\_enum module
----------------------------------------------------------
-
-.. automodule:: cpl.core.time.time_format_settings_names_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cpl.core.time
-   :members:
-   :undoc-members:
-   :show-inheritance: