Improved docs

docs/source/cli.generate.md

@@ -31,5 +31,5 @@ Generates files based on a schematic.
 | ```class```       | Class               | ```<name>```
 | ```enum```        | Enum class          | ```<name>```
 | ```service```     | Service class       | ```<name>```
-| ```settings```    | [Configmodel](cpl.configuration) | ```<name>```
+| ```settings```    | [Configmodel](cpl_core.configuration) | ```<name>```
 | ```thread```      | Thread class        | ```<name>```

docs/source/cli.publish.md

@@ -15,7 +15,7 @@ cpl **P**
 
 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.json```.
+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.

docs/source/cli.remove.md

@@ -13,12 +13,9 @@ cpl **R** *<project>*
 
 ## Description
 
-The command can be used to publish a project of type "console" or "library".
+Removes a project reference and the files from workspace.
 
-The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.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.
+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
 

docs/source/cpl.configuration.rst

@@ -1,42 +0,0 @@
-cpl.configuration
-=========================
-
-cpl.configuration.configuration
---------------------------------------
-
-.. automodule:: cpl.configuration.configuration
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.configuration.configuration\_abc
--------------------------------------------
-
-.. automodule:: cpl.configuration.configuration_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.configuration.configuration\_model\_abc
---------------------------------------------------
-
-.. automodule:: cpl.configuration.configuration_model_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.configuration.configuration\_variable\_name\_enum
-------------------------------------------------------------
-
-.. automodule:: cpl.configuration.configuration_variable_name_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.configuration.console\_argument
-------------------------------------------
-
-.. automodule:: cpl.configuration.console_argument
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/cpl.database.connection.rst

@@ -1,18 +0,0 @@
-cpl.database.connection
-===============================
-
-cpl.database.connection.database\_connection
----------------------------------------------------
-
-.. automodule:: cpl.database.connection.database_connection
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.database.connection.database\_connection\_abc
---------------------------------------------------------
-
-.. automodule:: cpl.database.connection.database_connection_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/cpl.database.context.rst

@@ -1,18 +0,0 @@
-cpl.database.context
-============================
-
-cpl.database.context.database\_context
----------------------------------------------
-
-.. automodule:: cpl.database.context.database_context
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.database.context.database\_context\_abc
---------------------------------------------------
-
-.. automodule:: cpl.database.context.database_context_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/cpl.dependency_injection.rst

@@ -1,50 +0,0 @@
-cpl.dependency\_injection
-=================================
-
-cpl.dependency\_injection.service\_collection
-----------------------------------------------------
-
-.. automodule:: cpl.dependency_injection.service_collection
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.dependency\_injection.service\_collection\_abc
----------------------------------------------------------
-
-.. automodule:: cpl.dependency_injection.service_collection_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.dependency\_injection.service\_descriptor
-----------------------------------------------------
-
-.. automodule:: cpl.dependency_injection.service_descriptor
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.dependency\_injection.service\_lifetime\_enum
---------------------------------------------------------
-
-.. automodule:: cpl.dependency_injection.service_lifetime_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.dependency\_injection.service\_provider
---------------------------------------------------
-
-.. automodule:: cpl.dependency_injection.service_provider
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.dependency\_injection.service\_provider\_abc
--------------------------------------------------------
-
-.. automodule:: cpl.dependency_injection.service_provider_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/cpl.environment.rst

@@ -1,26 +0,0 @@
-cpl.environment
-=======================
-
-cpl.environment.application\_environment
------------------------------------------------
-
-.. automodule:: cpl.environment.application_environment
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.environment.application\_environment\_abc
-----------------------------------------------------
-
-.. automodule:: cpl.environment.application_environment_abc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-cpl.environment.environment\_name\_enum
-----------------------------------------------
-
-.. automodule:: cpl.environment.environment_name_enum
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/cpl.rst

@@ -1,16 +0,0 @@
-API Reference
-===========
-
-.. toctree::
-    :maxdepth: 4
-
-    cpl.application
-    cpl.configuration
-    cpl.console
-    cpl.database
-    cpl.dependency_injection
-    cpl.environment
-    cpl.logging
-    cpl.mailing
-    cpl.time
-    cpl.utils

docs/source/cpl_core.application.rst

@@ -1,34 +1,34 @@
-cpl.application
+cpl_core.application
 =======================
 
-cpl.application.application\_abc
+cpl_core.application.application\_abc
 ---------------------------------------
 
-.. automodule:: cpl.application.application_abc
+.. automodule:: cpl_core.application.application_abc
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.application.application\_builder
+cpl_core.application.application\_builder
 -------------------------------------------
 
-.. automodule:: cpl.application.application_builder
+.. automodule:: cpl_core.application.application_builder
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.application.application\_builder\_abc
+cpl_core.application.application\_builder\_abc
 ------------------------------------------------
 
-.. automodule:: cpl.application.application_builder_abc
+.. automodule:: cpl_core.application.application_builder_abc
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.application.startup\_abc
+cpl_core.application.startup\_abc
 -----------------------------------
 
-.. automodule:: cpl.application.startup_abc
+.. automodule:: cpl_core.application.startup_abc
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/cpl_core.configuration.rst

@@ -0,0 +1,42 @@
+cpl_core.configuration
+=========================
+
+cpl_core.configuration.configuration
+--------------------------------------
+
+.. automodule:: cpl_core.configuration.configuration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.configuration.configuration\_abc
+-------------------------------------------
+
+.. automodule:: cpl_core.configuration.configuration_abc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.configuration.configuration\_model\_abc
+--------------------------------------------------
+
+.. automodule:: cpl_core.configuration.configuration_model_abc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.configuration.configuration\_variable\_name\_enum
+------------------------------------------------------------
+
+.. automodule:: cpl_core.configuration.configuration_variable_name_enum
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.configuration.console\_argument
+------------------------------------------
+
+.. automodule:: cpl_core.configuration.console_argument
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/cpl_core.console.rst

@@ -1,42 +1,42 @@
-cpl.console
+cpl_core.console
 ===================
 
-cpl.console.background\_color\_enum
+cpl_core.console.background\_color\_enum
 ------------------------------------------
 
-.. automodule:: cpl.console.background_color_enum
+.. automodule:: cpl_core.console.background_color_enum
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.console.console
+cpl_core.console.console
 --------------------------
 
-.. automodule:: cpl.console.console
+.. automodule:: cpl_core.console.console
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.console.console\_call
+cpl_core.console.console\_call
 --------------------------------
 
-.. automodule:: cpl.console.console_call
+.. automodule:: cpl_core.console.console_call
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.console.foreground\_color\_enum
+cpl_core.console.foreground\_color\_enum
 ------------------------------------------
 
-.. automodule:: cpl.console.foreground_color_enum
+.. automodule:: cpl_core.console.foreground_color_enum
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.console.spinner\_thread
+cpl_core.console.spinner\_thread
 ----------------------------------
 
-.. automodule:: cpl.console.spinner_thread
+.. automodule:: cpl_core.console.spinner_thread
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/cpl_core.database.connection.rst

@@ -0,0 +1,18 @@
+cpl_core.database.connection
+===============================
+
+cpl_core.database.connection.database\_connection
+---------------------------------------------------
+
+.. automodule:: cpl_core.database.connection.database_connection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.database.connection.database\_connection\_abc
+--------------------------------------------------------
+
+.. automodule:: cpl_core.database.connection.database_connection_abc
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/cpl_core.database.context.rst

@@ -0,0 +1,18 @@
+cpl_core.database.context
+============================
+
+cpl_core.database.context.database\_context
+---------------------------------------------
+
+.. automodule:: cpl_core.database.context.database_context
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.database.context.database\_context\_abc
+--------------------------------------------------
+
+.. automodule:: cpl_core.database.context.database_context_abc
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/cpl_core.database.rst

@@ -1,35 +1,35 @@
-cpl.database
+cpl_core.database
 ====================
 
 .. toctree::
    :maxdepth: 4
 
-   cpl.database.connection
-   cpl.database.context
+   cpl_core.database.connection
+   cpl_core.database.context
 
 Submodules
 ----------
 
-cpl.database.database\_model
+cpl_core.database.database\_model
 -----------------------------------
 
-.. automodule:: cpl.database.database_model
+.. automodule:: cpl_core.database.database_model
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.database.database\_settings
+cpl_core.database.database\_settings
 --------------------------------------
 
-.. automodule:: cpl.database.database_settings
+.. automodule:: cpl_core.database.database_settings
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.database.database\_settings\_name\_enum
+cpl_core.database.database\_settings\_name\_enum
 --------------------------------------------------
 
-.. automodule:: cpl.database.database_settings_name_enum
+.. automodule:: cpl_core.database.database_settings_name_enum
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/cpl_core.dependency_injection.rst

@@ -0,0 +1,50 @@
+cpl_core.dependency\_injection
+=================================
+
+cpl_core.dependency\_injection.service\_collection
+----------------------------------------------------
+
+.. automodule:: cpl_core.dependency_injection.service_collection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.dependency\_injection.service\_collection\_abc
+---------------------------------------------------------
+
+.. automodule:: cpl_core.dependency_injection.service_collection_abc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.dependency\_injection.service\_descriptor
+----------------------------------------------------
+
+.. automodule:: cpl_core.dependency_injection.service_descriptor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.dependency\_injection.service\_lifetime\_enum
+--------------------------------------------------------
+
+.. automodule:: cpl_core.dependency_injection.service_lifetime_enum
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.dependency\_injection.service\_provider
+--------------------------------------------------
+
+.. automodule:: cpl_core.dependency_injection.service_provider
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.dependency\_injection.service\_provider\_abc
+-------------------------------------------------------
+
+.. automodule:: cpl_core.dependency_injection.service_provider_abc
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/cpl_core.environment.rst

@@ -0,0 +1,26 @@
+cpl_core.environment
+=======================
+
+cpl_core.environment.application\_environment
+-----------------------------------------------
+
+.. automodule:: cpl_core.environment.application_environment
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.environment.application\_environment\_abc
+----------------------------------------------------
+
+.. automodule:: cpl_core.environment.application_environment_abc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cpl_core.environment.environment\_name\_enum
+----------------------------------------------
+
+.. automodule:: cpl_core.environment.environment_name_enum
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/cpl_core.logging.rst

@@ -1,42 +1,42 @@
-cpl.logging
+cpl_core.logging
 ===================
 
-cpl.logging.logger\_abc
+cpl_core.logging.logger\_abc
 ------------------------------
 
-.. automodule:: cpl.logging.logger_abc
+.. automodule:: cpl_core.logging.logger_abc
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.logging.logger\_service
+cpl_core.logging.logger\_service
 ----------------------------------
 
-.. automodule:: cpl.logging.logger_service
+.. automodule:: cpl_core.logging.logger_service
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.logging.logging\_level\_enum
+cpl_core.logging.logging\_level\_enum
 ---------------------------------------
 
-.. automodule:: cpl.logging.logging_level_enum
+.. automodule:: cpl_core.logging.logging_level_enum
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.logging.logging\_settings
+cpl_core.logging.logging\_settings
 ------------------------------------
 
-.. automodule:: cpl.logging.logging_settings
+.. automodule:: cpl_core.logging.logging_settings
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.logging.logging\_settings\_name\_enum
+cpl_core.logging.logging\_settings\_name\_enum
 ------------------------------------------------
 
-.. automodule:: cpl.logging.logging_settings_name_enum
+.. automodule:: cpl_core.logging.logging_settings_name_enum
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/cpl_core.mailing.rst

@@ -1,42 +1,42 @@
-cpl.mailing
+cpl_core.mailing
 ===================
 
-cpl.mailing.email
+cpl_core.mailing.email
 ------------------------
 
-.. automodule:: cpl.mailing.email
+.. automodule:: cpl_core.mailing.email
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.mailing.email\_client\_abc
+cpl_core.mailing.email\_client\_abc
 -------------------------------------
 
-.. automodule:: cpl.mailing.email_client_abc
+.. automodule:: cpl_core.mailing.email_client_abc
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.mailing.email\_client\_service
+cpl_core.mailing.email\_client\_service
 -----------------------------------------
 
-.. automodule:: cpl.mailing.email_client_service
+.. automodule:: cpl_core.mailing.email_client_service
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.mailing.email\_client\_settings
+cpl_core.mailing.email\_client\_settings
 ------------------------------------------
 
-.. automodule:: cpl.mailing.email_client_settings
+.. automodule:: cpl_core.mailing.email_client_settings
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.mailing.email\_client\_settings\_name\_enum
+cpl_core.mailing.email\_client\_settings\_name\_enum
 ------------------------------------------------------
 
-.. automodule:: cpl.mailing.email_client_settings_name_enum
+.. automodule:: cpl_core.mailing.email_client_settings_name_enum
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/cpl_core.rst

@@ -0,0 +1,16 @@
+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.logging
+    cpl_core.mailing
+    cpl_core.time
+    cpl_core.utils

docs/source/cpl_core.time.rst

@@ -1,18 +1,18 @@
-cpl.time
+cpl_core.time
 ================
 
-cpl.time.time\_format\_settings
+cpl_core.time.time\_format\_settings
 --------------------------------------
 
-.. automodule:: cpl.time.time_format_settings
+.. automodule:: cpl_core.time.time_format_settings
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.time.time\_format\_settings\_names\_enum
+cpl_core.time.time\_format\_settings\_names\_enum
 ---------------------------------------------------
 
-.. automodule:: cpl.time.time_format_settings_names_enum
+.. automodule:: cpl_core.time.time_format_settings_names_enum
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/cpl_core.utils.rst

@@ -1,26 +1,26 @@
-cpl.utils
+cpl_core.utils
 =================
 
-cpl.utils.credential\_manager
+cpl_core.utils.credential\_manager
 ------------------------------------
 
-.. automodule:: cpl.utils.credential_manager
+.. automodule:: cpl_core.utils.credential_manager
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.utils.pip
+cpl_core.utils.pip
 --------------------
 
-.. automodule:: cpl.utils.pip
+.. automodule:: cpl_core.utils.pip
    :members:
    :undoc-members:
    :show-inheritance:
 
-cpl.utils.string
+cpl_core.utils.string
 -----------------------
 
-.. automodule:: cpl.utils.string
+.. automodule:: cpl_core.utils.string
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/index.rst

@@ -20,5 +20,6 @@ These pages go into great detail about everything the Library can do.
 
    introduction
    getting_started
-   cpl
    cpl_cli
+   cpl_core
+   cpl_query

docs/source/modules.rst

@@ -5,5 +5,6 @@ cpl
     :maxdepth: 4
 
     getting_started
-    cpl
     cpl_cli
+    cpl_core
+    cpl_query

docs/source/quickstart.md

@@ -200,9 +200,9 @@ In this section, you've created an application that uses user input to generate
 
 To continue exploring CPL and developing applications:
 
-- [Application base](cpl.application)
-- [Dependency injection](cpl.dependency_injection)
-- [Console](cpl.console)
+- [Application base](cpl_core.application)
+- [Dependency injection](cpl_core.dependency_injection)
+- [Console](cpl_core.console)
 
 <!-- LINKS -->
 [pip-url]: https://pip.sh-edraft.de

docs/source/setup.md

@@ -41,7 +41,7 @@ pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
 
 ## Create initial console app
 
-You develop apps and packages in the context of an CPL project which is defined in an cpl.json.
+You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.
 
 1. Run the CLI command ```cpl new console``` and provide the name my-app, as shown here:
 
@@ -55,7 +55,7 @@ The CLI create a new workspace and a simple 'Hello World' app, ready to run.
 
 ## Create initial library
 
-You develop apps and packages in the context of an CPL project which is defined in an cpl.json.
+You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.
 
 1. Run the CLI command ```cpl new library``` and provide the name my-lib, as shown here: