sh_cpl/docs/build/html/searchindex.js

1 line
35 KiB
JavaScript

Search.setIndex({docnames:["cpl","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","cpl_cli","cpl_cli.command","cpl_cli.configuration","cpl_cli.live_server","cpl_cli.publish","cpl_cli.source_creator","index","modules","tests"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["cpl.rst","cpl.application.rst","cpl.configuration.rst","cpl.console.rst","cpl.database.rst","cpl.database.connection.rst","cpl.database.context.rst","cpl.dependency_injection.rst","cpl.environment.rst","cpl.logging.rst","cpl.mailing.rst","cpl.time.rst","cpl.utils.rst","cpl_cli.rst","cpl_cli.command.rst","cpl_cli.configuration.rst","cpl_cli.live_server.rst","cpl_cli.publish.rst","cpl_cli.source_creator.rst","index.rst","modules.rst","tests.rst"],objects:{"":{cpl:[0,0,0,"-"],cpl_cli:[13,0,0,"-"],tests:[21,0,0,"-"]},"cpl.VersionInfo":{major:[0,2,1,""],micro:[0,2,1,""],minor:[0,2,1,""]},"cpl.application":{application_abc:[1,0,0,"-"],application_builder:[1,0,0,"-"],application_builder_abc:[1,0,0,"-"],startup_abc:[1,0,0,"-"]},"cpl.application.application_abc":{ApplicationABC:[1,1,1,""]},"cpl.application.application_abc.ApplicationABC":{configure:[1,3,1,""],main:[1,3,1,""],run:[1,3,1,""]},"cpl.application.application_builder":{ApplicationBuilder:[1,1,1,""]},"cpl.application.application_builder.ApplicationBuilder":{build:[1,3,1,""],use_startup:[1,3,1,""]},"cpl.application.application_builder_abc":{ApplicationBuilderABC:[1,1,1,""]},"cpl.application.application_builder_abc.ApplicationBuilderABC":{build:[1,3,1,""],use_startup:[1,3,1,""]},"cpl.application.startup_abc":{StartupABC:[1,1,1,""]},"cpl.application.startup_abc.StartupABC":{configure_configuration:[1,3,1,""],configure_services:[1,3,1,""]},"cpl.configuration":{configuration:[2,0,0,"-"],configuration_abc:[2,0,0,"-"],configuration_model_abc:[2,0,0,"-"],configuration_variable_name_enum:[2,0,0,"-"],console_argument:[2,0,0,"-"]},"cpl.configuration.configuration":{Configuration:[2,1,1,""]},"cpl.configuration.configuration.Configuration":{add_configuration:[2,3,1,""],add_console_argument:[2,3,1,""],add_console_arguments:[2,3,1,""],add_environment_variables:[2,3,1,""],add_json_file:[2,3,1,""],additional_arguments:[2,3,1,""],argument_error_function:[2,3,1,""],environment:[2,3,1,""],get_configuration:[2,3,1,""]},"cpl.configuration.configuration_abc":{ConfigurationABC:[2,1,1,""]},"cpl.configuration.configuration_abc.ConfigurationABC":{add_configuration:[2,3,1,""],add_console_argument:[2,3,1,""],add_console_arguments:[2,3,1,""],add_environment_variables:[2,3,1,""],add_json_file:[2,3,1,""],additional_arguments:[2,3,1,""],argument_error_function:[2,3,1,""],environment:[2,3,1,""],get_configuration:[2,3,1,""]},"cpl.configuration.configuration_model_abc":{ConfigurationModelABC:[2,1,1,""]},"cpl.configuration.configuration_model_abc.ConfigurationModelABC":{from_dict:[2,3,1,""]},"cpl.configuration.configuration_variable_name_enum":{ConfigurationVariableNameEnum:[2,1,1,""]},"cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum":{customer:[2,2,1,""],environment:[2,2,1,""],name:[2,2,1,""],to_list:[2,3,1,""]},"cpl.configuration.console_argument":{ConsoleArgument:[2,1,1,""]},"cpl.configuration.console_argument.ConsoleArgument":{aliases:[2,3,1,""],console_arguments:[2,3,1,""],is_value_token_optional:[2,3,1,""],name:[2,3,1,""],token:[2,3,1,""],value_token:[2,3,1,""]},"cpl.console":{background_color_enum:[3,0,0,"-"],console:[3,0,0,"-"],console_call:[3,0,0,"-"],foreground_color_enum:[3,0,0,"-"],spinner_thread:[3,0,0,"-"]},"cpl.console.background_color_enum":{BackgroundColorEnum:[3,1,1,""]},"cpl.console.background_color_enum.BackgroundColorEnum":{"default":[3,2,1,""],blue:[3,2,1,""],cyan:[3,2,1,""],green:[3,2,1,""],grey:[3,2,1,""],magenta:[3,2,1,""],red:[3,2,1,""],white:[3,2,1,""],yellow:[3,2,1,""]},"cpl.console.console":{Console:[3,1,1,""]},"cpl.console.console.Console":{background_color:[3,2,1,""],banner:[3,3,1,""],clear:[3,3,1,""],close:[3,3,1,""],color_reset:[3,3,1,""],disable:[3,3,1,""],enable:[3,3,1,""],error:[3,3,1,""],foreground_color:[3,2,1,""],read:[3,3,1,""],read_line:[3,3,1,""],reset_cursor_position:[3,3,1,""],select:[3,3,1,""],set_background_color:[3,3,1,""],set_cursor_position:[3,3,1,""],set_foreground_color:[3,3,1,""],set_hold_back:[3,3,1,""],spinner:[3,3,1,""],table:[3,3,1,""],write:[3,3,1,""],write_at:[3,3,1,""],write_line:[3,3,1,""],write_line_at:[3,3,1,""]},"cpl.console.console_call":{ConsoleCall:[3,1,1,""]},"cpl.console.console_call.ConsoleCall":{"function":[3,3,1,""],args:[3,3,1,""]},"cpl.console.foreground_color_enum":{ForegroundColorEnum:[3,1,1,""]},"cpl.console.foreground_color_enum.ForegroundColorEnum":{"default":[3,2,1,""],blue:[3,2,1,""],cyan:[3,2,1,""],green:[3,2,1,""],grey:[3,2,1,""],magenta:[3,2,1,""],red:[3,2,1,""],white:[3,2,1,""],yellow:[3,2,1,""]},"cpl.console.spinner_thread":{SpinnerThread:[3,1,1,""]},"cpl.console.spinner_thread.SpinnerThread":{exit:[3,3,1,""],run:[3,3,1,""],stop_spinning:[3,3,1,""]},"cpl.database":{database_model:[4,0,0,"-"],database_settings:[4,0,0,"-"],database_settings_name_enum:[4,0,0,"-"]},"cpl.database.connection":{database_connection:[5,0,0,"-"],database_connection_abc:[5,0,0,"-"]},"cpl.database.connection.database_connection":{DatabaseConnection:[5,1,1,""]},"cpl.database.connection.database_connection.DatabaseConnection":{connect:[5,3,1,""],engine:[5,3,1,""],session:[5,3,1,""]},"cpl.database.connection.database_connection_abc":{DatabaseConnectionABC:[5,1,1,""]},"cpl.database.connection.database_connection_abc.DatabaseConnectionABC":{connect:[5,3,1,""],engine:[5,3,1,""],session:[5,3,1,""]},"cpl.database.context":{database_context:[6,0,0,"-"],database_context_abc:[6,0,0,"-"]},"cpl.database.context.database_context":{DatabaseContext:[6,1,1,""]},"cpl.database.context.database_context.DatabaseContext":{connect:[6,3,1,""],engine:[6,3,1,""],save_changes:[6,3,1,""],session:[6,3,1,""]},"cpl.database.context.database_context_abc":{DatabaseContextABC:[6,1,1,""]},"cpl.database.context.database_context_abc.DatabaseContextABC":{connect:[6,3,1,""],engine:[6,3,1,""],save_changes:[6,3,1,""],session:[6,3,1,""]},"cpl.database.database_settings":{DatabaseSettings:[4,1,1,""]},"cpl.database.database_settings.DatabaseSettings":{auth_plugin:[4,3,1,""],case_sensitive:[4,3,1,""],connection_string:[4,3,1,""],credentials:[4,3,1,""],echo:[4,3,1,""],encoding:[4,3,1,""],from_dict:[4,3,1,""]},"cpl.database.database_settings_name_enum":{DatabaseSettingsNameEnum:[4,1,1,""]},"cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum":{auth_plugin:[4,2,1,""],case_sensitive:[4,2,1,""],connection_string:[4,2,1,""],credentials:[4,2,1,""],echo:[4,2,1,""],encoding:[4,2,1,""]},"cpl.dependency_injection":{service_collection:[7,0,0,"-"],service_collection_abc:[7,0,0,"-"],service_descriptor:[7,0,0,"-"],service_lifetime_enum:[7,0,0,"-"],service_provider:[7,0,0,"-"],service_provider_abc:[7,0,0,"-"]},"cpl.dependency_injection.service_collection":{ServiceCollection:[7,1,1,""]},"cpl.dependency_injection.service_collection.ServiceCollection":{add_db_context:[7,3,1,""],add_logging:[7,3,1,""],add_scoped:[7,3,1,""],add_singleton:[7,3,1,""],add_transient:[7,3,1,""],build_service_provider:[7,3,1,""]},"cpl.dependency_injection.service_collection_abc":{ServiceCollectionABC:[7,1,1,""]},"cpl.dependency_injection.service_collection_abc.ServiceCollectionABC":{add_db_context:[7,3,1,""],add_logging:[7,3,1,""],add_scoped:[7,3,1,""],add_singleton:[7,3,1,""],add_transient:[7,3,1,""],build_service_provider:[7,3,1,""]},"cpl.dependency_injection.service_descriptor":{ServiceDescriptor:[7,1,1,""]},"cpl.dependency_injection.service_descriptor.ServiceDescriptor":{implementation:[7,3,1,""],lifetime:[7,3,1,""],service_type:[7,3,1,""]},"cpl.dependency_injection.service_lifetime_enum":{ServiceLifetimeEnum:[7,1,1,""]},"cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum":{"transient":[7,2,1,""],scoped:[7,2,1,""],singleton:[7,2,1,""]},"cpl.dependency_injection.service_provider":{ServiceProvider:[7,1,1,""]},"cpl.dependency_injection.service_provider.ServiceProvider":{build_service:[7,3,1,""],get_service:[7,3,1,""]},"cpl.dependency_injection.service_provider_abc":{ServiceProviderABC:[7,1,1,""]},"cpl.dependency_injection.service_provider_abc.ServiceProviderABC":{build_service:[7,3,1,""],get_service:[7,3,1,""]},"cpl.environment":{application_environment:[8,0,0,"-"],application_environment_abc:[8,0,0,"-"],environment_name_enum:[8,0,0,"-"]},"cpl.environment.application_environment":{ApplicationEnvironment:[8,1,1,""]},"cpl.environment.application_environment.ApplicationEnvironment":{application_name:[8,3,1,""],customer:[8,3,1,""],date_time_now:[8,3,1,""],end_time:[8,3,1,""],environment_name:[8,3,1,""],host_name:[8,3,1,""],runtime_directory:[8,3,1,""],set_runtime_directory:[8,3,1,""],set_working_directory:[8,3,1,""],start_time:[8,3,1,""],working_directory:[8,3,1,""]},"cpl.environment.application_environment_abc":{ApplicationEnvironmentABC:[8,1,1,""]},"cpl.environment.application_environment_abc.ApplicationEnvironmentABC":{application_name:[8,3,1,""],customer:[8,3,1,""],date_time_now:[8,3,1,""],end_time:[8,3,1,""],environment_name:[8,3,1,""],host_name:[8,3,1,""],runtime_directory:[8,3,1,""],set_runtime_directory:[8,3,1,""],set_working_directory:[8,3,1,""],start_time:[8,3,1,""],working_directory:[8,3,1,""]},"cpl.environment.environment_name_enum":{EnvironmentNameEnum:[8,1,1,""]},"cpl.environment.environment_name_enum.EnvironmentNameEnum":{development:[8,2,1,""],production:[8,2,1,""],staging:[8,2,1,""],testing:[8,2,1,""]},"cpl.logging":{logger_abc:[9,0,0,"-"],logger_service:[9,0,0,"-"],logging_level_enum:[9,0,0,"-"],logging_settings:[9,0,0,"-"],logging_settings_name_enum:[9,0,0,"-"]},"cpl.logging.logger_abc":{LoggerABC:[9,1,1,""]},"cpl.logging.logger_abc.LoggerABC":{debug:[9,3,1,""],error:[9,3,1,""],fatal:[9,3,1,""],header:[9,3,1,""],info:[9,3,1,""],trace:[9,3,1,""],warn:[9,3,1,""]},"cpl.logging.logger_service":{Logger:[9,1,1,""]},"cpl.logging.logger_service.Logger":{create:[9,3,1,""],debug:[9,3,1,""],error:[9,3,1,""],fatal:[9,3,1,""],header:[9,3,1,""],info:[9,3,1,""],trace:[9,3,1,""],warn:[9,3,1,""]},"cpl.logging.logging_level_enum":{LoggingLevelEnum:[9,1,1,""]},"cpl.logging.logging_level_enum.LoggingLevelEnum":{DEBUG:[9,2,1,""],ERROR:[9,2,1,""],FATAL:[9,2,1,""],INFO:[9,2,1,""],OFF:[9,2,1,""],TRACE:[9,2,1,""],WARN:[9,2,1,""]},"cpl.logging.logging_settings":{LoggingSettings:[9,1,1,""]},"cpl.logging.logging_settings.LoggingSettings":{console:[9,3,1,""],filename:[9,3,1,""],from_dict:[9,3,1,""],level:[9,3,1,""],path:[9,3,1,""]},"cpl.logging.logging_settings_name_enum":{LoggingSettingsNameEnum:[9,1,1,""]},"cpl.logging.logging_settings_name_enum.LoggingSettingsNameEnum":{console_level:[9,2,1,""],file_level:[9,2,1,""],filename:[9,2,1,""],path:[9,2,1,""]},"cpl.mailing":{email:[10,0,0,"-"],email_client_abc:[10,0,0,"-"],email_client_service:[10,0,0,"-"],email_client_settings:[10,0,0,"-"],email_client_settings_name_enum:[10,0,0,"-"]},"cpl.mailing.email":{EMail:[10,1,1,""]},"cpl.mailing.email.EMail":{add_header:[10,3,1,""],add_receiver:[10,3,1,""],body:[10,3,1,""],check_mail:[10,3,1,""],get_content:[10,3,1,""],header:[10,3,1,""],header_list:[10,3,1,""],receiver:[10,3,1,""],receiver_list:[10,3,1,""],subject:[10,3,1,""],transceiver:[10,3,1,""]},"cpl.mailing.email_client_abc":{EMailClientABC:[10,1,1,""]},"cpl.mailing.email_client_abc.EMailClientABC":{connect:[10,3,1,""],send_mail:[10,3,1,""]},"cpl.mailing.email_client_service":{EMailClient:[10,1,1,""]},"cpl.mailing.email_client_service.EMailClient":{connect:[10,3,1,""],create:[10,3,1,""],login:[10,3,1,""],send_mail:[10,3,1,""]},"cpl.mailing.email_client_settings":{EMailClientSettings:[10,1,1,""]},"cpl.mailing.email_client_settings.EMailClientSettings":{credentials:[10,3,1,""],from_dict:[10,3,1,""],host:[10,3,1,""],port:[10,3,1,""],user_name:[10,3,1,""]},"cpl.mailing.email_client_settings_name_enum":{EMailClientSettingsNameEnum:[10,1,1,""]},"cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum":{credentials:[10,2,1,""],host:[10,2,1,""],port:[10,2,1,""],user_name:[10,2,1,""]},"cpl.time":{time_format_settings:[11,0,0,"-"],time_format_settings_names_enum:[11,0,0,"-"]},"cpl.time.time_format_settings":{TimeFormatSettings:[11,1,1,""]},"cpl.time.time_format_settings.TimeFormatSettings":{date_format:[11,3,1,""],date_time_format:[11,3,1,""],date_time_log_format:[11,3,1,""],from_dict:[11,3,1,""],time_format:[11,3,1,""]},"cpl.time.time_format_settings_names_enum":{TimeFormatSettingsNamesEnum:[11,1,1,""]},"cpl.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum":{date_format:[11,2,1,""],date_time_format:[11,2,1,""],date_time_log_format:[11,2,1,""],time_format:[11,2,1,""]},"cpl.utils":{credential_manager:[12,0,0,"-"],pip:[12,0,0,"-"],string:[12,0,0,"-"]},"cpl.utils.credential_manager":{CredentialManager:[12,1,1,""]},"cpl.utils.credential_manager.CredentialManager":{build_string:[12,3,1,""],decrypt:[12,3,1,""],encrypt:[12,3,1,""]},"cpl.utils.pip":{Pip:[12,1,1,""]},"cpl.utils.pip.Pip":{get_executable:[12,3,1,""],get_outdated:[12,3,1,""],get_package:[12,3,1,""],install:[12,3,1,""],reset_executable:[12,3,1,""],set_executable:[12,3,1,""],uninstall:[12,3,1,""]},"cpl.utils.string":{String:[12,1,1,""]},"cpl.utils.string.String":{convert_to_camel_case:[12,3,1,""],convert_to_snake_case:[12,3,1,""],first_to_lower:[12,3,1,""],first_to_upper:[12,3,1,""],random_string:[12,3,1,""]},"cpl_cli.VersionInfo":{major:[13,2,1,""],micro:[13,2,1,""],minor:[13,2,1,""]},"cpl_cli.cli":{CLI:[13,1,1,""]},"cpl_cli.cli.CLI":{configure:[13,3,1,""],main:[13,3,1,""]},"cpl_cli.cli_settings":{CLISettings:[13,1,1,""]},"cpl_cli.cli_settings.CLISettings":{from_dict:[13,3,1,""],pip_path:[13,3,1,""]},"cpl_cli.cli_settings_name_enum":{CLISettingsNameEnum:[13,1,1,""]},"cpl_cli.cli_settings_name_enum.CLISettingsNameEnum":{pip_path:[13,2,1,""]},"cpl_cli.command":{add_service:[14,0,0,"-"],build_service:[14,0,0,"-"],generate_service:[14,0,0,"-"],help_service:[14,0,0,"-"],install_service:[14,0,0,"-"],new_service:[14,0,0,"-"],publish_service:[14,0,0,"-"],remove_service:[14,0,0,"-"],start_service:[14,0,0,"-"],uninstall_service:[14,0,0,"-"],update_service:[14,0,0,"-"],version_service:[14,0,0,"-"]},"cpl_cli.command.add_service":{AddService:[14,1,1,""]},"cpl_cli.command.add_service.AddService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command.build_service":{BuildService:[14,1,1,""]},"cpl_cli.command.build_service.BuildService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command.generate_service":{GenerateService:[14,1,1,""]},"cpl_cli.command.generate_service.GenerateService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command.help_service":{HelpService:[14,1,1,""]},"cpl_cli.command.help_service.HelpService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command.install_service":{InstallService:[14,1,1,""]},"cpl_cli.command.install_service.InstallService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command.new_service":{NewService:[14,1,1,""]},"cpl_cli.command.new_service.NewService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command.publish_service":{PublishService:[14,1,1,""]},"cpl_cli.command.publish_service.PublishService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command.remove_service":{RemoveService:[14,1,1,""]},"cpl_cli.command.remove_service.RemoveService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command.start_service":{StartService:[14,1,1,""]},"cpl_cli.command.start_service.StartService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command.uninstall_service":{UninstallService:[14,1,1,""]},"cpl_cli.command.uninstall_service.UninstallService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command.update_service":{UpdateService:[14,1,1,""]},"cpl_cli.command.update_service.UpdateService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command.version_service":{VersionService:[14,1,1,""]},"cpl_cli.command.version_service.VersionService":{help_message:[14,3,1,""],run:[14,3,1,""]},"cpl_cli.command_abc":{CommandABC:[13,1,1,""]},"cpl_cli.command_abc.CommandABC":{help_message:[13,3,1,""],run:[13,3,1,""]},"cpl_cli.command_handler_service":{CommandHandler:[13,1,1,""]},"cpl_cli.command_handler_service.CommandHandler":{add_command:[13,3,1,""],commands:[13,3,1,""],handle:[13,3,1,""],remove_command:[13,3,1,""]},"cpl_cli.command_model":{CommandModel:[13,1,1,""]},"cpl_cli.command_model.CommandModel":{aliases:[13,3,1,""],change_cwd:[13,3,1,""],command:[13,3,1,""],is_project_needed:[13,3,1,""],is_workspace_needed:[13,3,1,""],name:[13,3,1,""]},"cpl_cli.configuration":{build_settings:[15,0,0,"-"],build_settings_name_enum:[15,0,0,"-"],project_settings:[15,0,0,"-"],project_settings_name_enum:[15,0,0,"-"],project_type_enum:[15,0,0,"-"],settings_helper:[15,0,0,"-"],version_settings:[15,0,0,"-"],version_settings_name_enum:[15,0,0,"-"],workspace_settings:[15,0,0,"-"],workspace_settings_name_enum:[15,0,0,"-"]},"cpl_cli.configuration.build_settings":{BuildSettings:[15,1,1,""]},"cpl_cli.configuration.build_settings.BuildSettings":{entry_point:[15,3,1,""],excluded:[15,3,1,""],from_dict:[15,3,1,""],include_package_data:[15,3,1,""],included:[15,3,1,""],main:[15,3,1,""],output_path:[15,3,1,""],package_data:[15,3,1,""],project_references:[15,3,1,""],project_type:[15,3,1,""],source_path:[15,3,1,""]},"cpl_cli.configuration.build_settings_name_enum":{BuildSettingsNameEnum:[15,1,1,""]},"cpl_cli.configuration.build_settings_name_enum.BuildSettingsNameEnum":{entry_point:[15,2,1,""],excluded:[15,2,1,""],include_package_data:[15,2,1,""],included:[15,2,1,""],main:[15,2,1,""],output_path:[15,2,1,""],package_data:[15,2,1,""],project_references:[15,2,1,""],project_type:[15,2,1,""],source_path:[15,2,1,""]},"cpl_cli.configuration.project_settings":{ProjectSettings:[15,1,1,""]},"cpl_cli.configuration.project_settings.ProjectSettings":{author:[15,3,1,""],author_email:[15,3,1,""],classifiers:[15,3,1,""],copyright_date:[15,3,1,""],copyright_name:[15,3,1,""],dependencies:[15,3,1,""],description:[15,3,1,""],from_dict:[15,3,1,""],license_description:[15,3,1,""],license_name:[15,3,1,""],long_description:[15,3,1,""],name:[15,3,1,""],python_executable:[15,3,1,""],python_path:[15,3,1,""],python_version:[15,3,1,""],url:[15,3,1,""],version:[15,3,1,""]},"cpl_cli.configuration.project_settings_name_enum":{ProjectSettingsNameEnum:[15,1,1,""]},"cpl_cli.configuration.project_settings_name_enum.ProjectSettingsNameEnum":{author:[15,2,1,""],author_email:[15,2,1,""],classifiers:[15,2,1,""],copyright_date:[15,2,1,""],copyright_name:[15,2,1,""],dependencies:[15,2,1,""],description:[15,2,1,""],license_description:[15,2,1,""],license_name:[15,2,1,""],long_description:[15,2,1,""],name:[15,2,1,""],python_path:[15,2,1,""],python_version:[15,2,1,""],url:[15,2,1,""],version:[15,2,1,""]},"cpl_cli.configuration.project_type_enum":{ProjectTypeEnum:[15,1,1,""]},"cpl_cli.configuration.project_type_enum.ProjectTypeEnum":{console:[15,2,1,""],library:[15,2,1,""]},"cpl_cli.configuration.settings_helper":{SettingsHelper:[15,1,1,""]},"cpl_cli.configuration.settings_helper.SettingsHelper":{get_build_settings_dict:[15,3,1,""],get_project_settings_dict:[15,3,1,""]},"cpl_cli.configuration.version_settings":{VersionSettings:[15,1,1,""]},"cpl_cli.configuration.version_settings.VersionSettings":{from_dict:[15,3,1,""],major:[15,3,1,""],micro:[15,3,1,""],minor:[15,3,1,""],to_dict:[15,3,1,""],to_str:[15,3,1,""]},"cpl_cli.configuration.version_settings_name_enum":{VersionSettingsNameEnum:[15,1,1,""]},"cpl_cli.configuration.version_settings_name_enum.VersionSettingsNameEnum":{major:[15,2,1,""],micro:[15,2,1,""],minor:[15,2,1,""]},"cpl_cli.configuration.workspace_settings":{WorkspaceSettings:[15,1,1,""]},"cpl_cli.configuration.workspace_settings.WorkspaceSettings":{default_project:[15,3,1,""],from_dict:[15,3,1,""],projects:[15,3,1,""]},"cpl_cli.configuration.workspace_settings_name_enum":{WorkspaceSettingsNameEnum:[15,1,1,""]},"cpl_cli.configuration.workspace_settings_name_enum.WorkspaceSettingsNameEnum":{default_project:[15,2,1,""],projects:[15,2,1,""]},"cpl_cli.error":{Error:[13,1,1,""]},"cpl_cli.error.Error":{error:[13,3,1,""],warn:[13,3,1,""]},"cpl_cli.live_server":{live_server_service:[16,0,0,"-"],live_server_thread:[16,0,0,"-"]},"cpl_cli.live_server.live_server_service":{LiveServerService:[16,1,1,""]},"cpl_cli.live_server.live_server_service.LiveServerService":{on_modified:[16,3,1,""],start:[16,3,1,""]},"cpl_cli.live_server.live_server_thread":{LiveServerThread:[16,1,1,""]},"cpl_cli.live_server.live_server_thread.LiveServerThread":{command:[16,3,1,""],main:[16,3,1,""],run:[16,3,1,""]},"cpl_cli.main":{main:[13,4,1,""]},"cpl_cli.publish":{publisher_abc:[17,0,0,"-"],publisher_service:[17,0,0,"-"]},"cpl_cli.publish.publisher_abc":{PublisherABC:[17,1,1,""]},"cpl_cli.publish.publisher_abc.PublisherABC":{build:[17,3,1,""],dist_path:[17,3,1,""],exclude:[17,3,1,""],include:[17,3,1,""],publish:[17,3,1,""],source_path:[17,3,1,""]},"cpl_cli.publish.publisher_service":{PublisherService:[17,1,1,""]},"cpl_cli.publish.publisher_service.PublisherService":{build:[17,3,1,""],dist_path:[17,3,1,""],exclude:[17,3,1,""],include:[17,3,1,""],publish:[17,3,1,""],source_path:[17,3,1,""]},"cpl_cli.source_creator":{console_builder:[18,0,0,"-"],library_builder:[18,0,0,"-"],template_builder:[18,0,0,"-"]},"cpl_cli.source_creator.console_builder":{ConsoleBuilder:[18,1,1,""]},"cpl_cli.source_creator.console_builder.ConsoleBuilder":{build:[18,3,1,""]},"cpl_cli.source_creator.library_builder":{LibraryBuilder:[18,1,1,""]},"cpl_cli.source_creator.library_builder.LibraryBuilder":{build:[18,3,1,""]},"cpl_cli.source_creator.template_builder":{TemplateBuilder:[18,1,1,""]},"cpl_cli.source_creator.template_builder.TemplateBuilder":{build:[18,3,1,""]},"cpl_cli.startup":{Startup:[13,1,1,""]},"cpl_cli.startup.Startup":{configure_configuration:[13,3,1,""],configure_services:[13,3,1,""]},"tests.VersionInfo":{major:[21,2,1,""],micro:[21,2,1,""],minor:[21,2,1,""]},cpl:{VersionInfo:[0,1,1,""]},cpl_cli:{VersionInfo:[13,1,1,""],cli:[13,0,0,"-"],cli_settings:[13,0,0,"-"],cli_settings_name_enum:[13,0,0,"-"],command_abc:[13,0,0,"-"],command_handler_service:[13,0,0,"-"],command_model:[13,0,0,"-"],error:[13,0,0,"-"],main:[13,0,0,"-"],startup:[13,0,0,"-"]},tests:{VersionInfo:[21,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:function"},terms:{"2020":[0,13,21],"2021":[0,13,21],"abstract":[1,2,5,6,7,8,9,10,13,17],"byte":12,"case":12,"char":[3,12],"class":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,21],"default":3,"enum":[2,3,4,7,8,9,10,11,13,15],"function":[3,12],"int":[3,12],"new":3,"return":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"static":[2,10,12,13,15,18],"transient":7,"true":2,The:19,These:19,Useful:[3,12],__init__:17,_templat:18,abc:[1,2,3,5,6,7,8,9,10,13,17],about:19,activ:3,add:[2,7,10],add_command:13,add_configur:2,add_console_argu:2,add_db_context:7,add_environment_vari:2,add_head:10,add_json_fil:2,add_log:7,add_receiv:10,add_scop:7,add_servic:[13,20],add_singleton:7,add_transi:7,additional_argu:2,address:10,addservic:14,alia:[0,13,21],alias:[2,13],all:17,ani:3,app:[1,19],applic:[0,3,13,19,20],application_abc:[0,13,20],application_build:[0,20],application_builder_abc:[0,20],application_environ:[0,20],application_environment_abc:[0,9,10,14,16,17,20],application_nam:8,applicationabc:[1,13],applicationbuild:1,applicationbuilderabc:1,applicationenviron:8,applicationenvironmentabc:[8,9,10,14,16,17],arg:[1,3,6,12,13,14,16],argument:2,argument_error_funct:2,attribut:[2,4,9,10,11,13,15],auth_plugin:4,author:15,author_email:15,authoremail:15,authplugin:4,background:3,background_color:3,background_color_enum:[0,20],backgroundcolorenum:3,banner:3,base64:12,base:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,21],blue:3,bodi:10,bool:[2,3,10,13,18],build:[1,12,15,17,18],build_servic:[7,13,20],build_service_provid:7,build_set:[13,14,16,17,20],build_settings_name_enum:[13,20],build_str:12,buildservic:14,buildset:[14,15,16,17],buildsettingsnameenum:15,call:3,callabl:[2,3,7,13],camel:12,can:19,case_sensit:4,casesensit:4,chang:6,change_cwd:13,check:10,check_mail:10,classifi:15,classmethod:[3,12,18],clear:3,cli:20,cli_set:[14,20],cli_settings_name_enum:20,cliset:[13,14],clisettingsnameenum:13,close:3,cmd:13,cmd_handler:14,collect:[2,3,7,13],color:3,color_reset:3,command:[12,13,16,20],command_abc:[14,20],command_handler_servic:[14,20],command_model:20,commandabc:[13,14],commandhandl:[13,14],commandmodel:13,common:[19,20],complex:19,config:[1,7,13,14,17],configur:[0,1,4,7,9,10,11,13,14,16,17,18,20],configuration_abc:[0,1,7,13,14,17,20],configuration_model_abc:[0,4,9,10,11,13,15,20],configuration_variable_name_enum:[0,20],configurationabc:[1,2,7,13,14,17],configurationmodelabc:[2,4,9,10,11,13,15],configurationvariablenameenum:2,configure_configur:[1,13],configure_servic:[1,13],connect:[0,4,6,10,20],connection_str:[4,5,6],connectionstr:4,consol:[0,2,9,15,18,20],console_argu:[0,20],console_build:[13,20],console_cal:[0,20],console_level:9,consoleargu:2,consolebuild:18,consolecal:3,consoleloglevel:9,content:20,context:[0,4,7,20],convert:[2,4,9,10,11,12,13,15],convert_to_camel_cas:12,convert_to_snake_cas:12,copi:17,copyright:[0,13,21],copyright_d:15,copyright_nam:15,copyrightd:15,copyrightnam:15,cpl:[13,14,15,16,17],cpl_cli:[19,20],creat:[1,7,9,10,12,13,18,19],credenti:[4,10,12],credential_manag:[0,20],credentialmanag:12,current:8,cursor:3,cursor_background_color:3,cursor_foreground_color:3,custom:[1,2,8],cyan:3,databas:[0,7,20],database_connect:[0,4,20],database_connection_abc:[0,4,20],database_context:[0,4,20],database_context_abc:[0,4,7,20],database_model:[0,20],database_set:[0,5,6,7,20],database_settings_name_enum:[0,20],databaseconnect:5,databaseconnectionabc:5,databasecontext:6,databasecontextabc:[6,7],databaseset:[4,5,6,7],databasesettingsnameenum:4,date_format:11,date_time_format:11,date_time_log_format:11,date_time_now:8,dateformat:11,datetimeformat:11,datetimelogformat:11,db_context:7,db_context_typ:7,db_set:7,debug:9,decod:12,decrypt:12,default_project:15,defaultproject:15,defin:2,depend:15,dependency_inject:[0,1,13,14,20],descript:15,desktop:19,detail:[0,13,19,21],develop:[8,16,19],dict:[2,4,9,10,11,13,15,18],directori:8,disabl:3,dist_path:17,echo:4,edraft:20,effici:19,email:[0,20],email_client_abc:[0,20],email_client_servic:[0,20],email_client_set:[0,20],email_client_settings_name_enum:[0,20],emailcli:10,emailclientabc:10,emailclientset:10,emailclientsettingsnameenum:10,enabl:3,encod:[4,12],encrypt:12,end:3,end_tim:8,engin:[5,6],enterpris:19,entri:[1,3,13,14],entry_point:15,entrypoint:15,enumer:[2,3,4,7,8,9,10,11,13,15],env:[9,14,16,17],environ:[0,2,9,10,14,16,17,20],environment_nam:8,environment_name_enum:[0,20],environmentnameenum:8,error:[2,3,9,20],event:16,everyth:19,except:9,exclud:[15,17],execut:[12,16],exit:[3,9],fatal:9,field:[0,13,21],file:[2,16,17,18],file_level:9,fileloglevel:9,filenam:9,filesystemeventhandl:16,first:[12,19],first_to_low:12,first_to_upp:12,foreground:3,foreground_color:3,foreground_color_enum:[0,20],foregroundcolorenum:3,from:[2,17,19],from_dict:[2,4,9,10,11,13,15],gener:17,generate_servic:[13,20],generateservic:14,get:12,get_build_settings_dict:15,get_configur:2,get_cont:10,get_execut:12,get_outd:12,get_packag:12,get_project_settings_dict:15,get_servic:7,given:[2,3,7,12,17],great:19,green:3,grei:3,handl:[3,12,13],has:3,header:[3,9,10],header_background_color:3,header_foreground_color:3,header_list:10,help:19,help_messag:[13,14],help_servic:[13,20],helpservic:14,host:[1,10],host_nam:8,implement:7,includ:[15,17],include_package_data:15,includepackagedata:15,incom:13,info:9,inform:[9,17],input:3,instal:12,install_servic:[13,20],installservic:14,instanc:7,instance_typ:7,interact:3,interfac:13,intern:7,invalid:2,is_project_need:13,is_value_token_opt:2,is_workspace_need:13,json:2,key_typ:2,known:2,kwarg:3,learn:19,length:12,level:9,librari:[15,18,19,20],library_build:[13,20],librarybuild:18,licens:[0,13,21],license_descript:15,license_nam:15,licensedescript:15,licensenam:15,lifetim:7,line:[3,13],list:[2,3,7,10,12,13,14,16],live:16,live_serv:[13,14,20],live_server_servic:[13,14,20],live_server_thread:[13,20],liveserverservic:[14,16],liveserverthread:16,local:12,log:[0,10,20],logfil:9,logger:[7,9,10],logger_abc:[0,10,20],logger_servic:[0,20],loggerabc:[9,10],logging_level_enum:[0,20],logging_set:[0,20],logging_settings_name_enum:[0,20],logginglevelenum:9,loggingset:9,loggingsettingsnameenum:9,login:10,long_descript:15,longdescript:15,lower:12,magenta:3,mail:[0,20],mail_set:10,main:[1,15,16,20],major:[0,13,15,21],meant:19,menu:3,messag:[3,9,13],micro:[0,13,15,21],minor:[0,13,15,21],mit:[0,13,21],modifi:16,modul:20,more:[0,13,21],msg_len:3,name:[2,8,9,13,15],new_servic:[13,20],newservic:14,next:3,none:[2,3,7,9,10,12,15],number:[0,13,21],object:[2,3,7,10,12,13,15,18],off:9,on_blu:3,on_cyan:3,on_default:3,on_green:3,on_grei:3,on_magenta:3,on_modifi:16,on_r:3,on_whit:3,on_yellow:3,option:[2,3,7,9,10,12,15,18],option_background_color:3,option_foreground_color:3,outdat:12,output:[2,3],output_path:15,outputpath:15,packag:[12,19],package_data:15,packagedata:15,page:19,param:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],path:[2,9,16,17],pip:[0,20],pip_path:13,pippath:13,platform:19,point:[1,3,13,14],port:10,posit:3,prefix:2,prepar:[1,13],print:3,product:8,project:[15,16,17,18],project_nam:18,project_path:18,project_refer:15,project_set:[13,14,16,17,18,20],project_settings_name_enum:[13,20],project_typ:15,project_type_enum:[13,20],projectrefer:15,projectset:[14,15,16,17],projectsettingsnameenum:15,projecttyp:15,projecttypeenum:15,properti:[2,3,4,5,6,7,8,9,10,11,13,14,15,16,17],provid:[1,7,13],publish:[13,14,20],publish_servic:[13,20],publisher_abc:[13,14,20],publisher_servic:[13,20],publisherabc:[14,17],publisherservic:17,publishservic:14,python:[19,20],python_execut:15,python_path:15,python_vers:15,pythonpath:15,pythonvers:15,random:12,random_str:12,read:[2,3,17],read_lin:3,receiv:10,receiver_list:10,red:3,remov:17,remove_command:13,remove_servic:[13,20],removeservic:14,reset:[3,12],reset_cursor_posit:3,reset_execut:12,run:[1,3,13,14,16],runtim:[1,8],runtime_directori:8,save:[2,6],save_chang:6,scope:7,search_typ:2,see:[0,13,21],select:3,send:10,send_mail:10,server:[10,16,19],servic:[1,7,13,14],service_collect:[0,20],service_collection_abc:[0,13,20],service_descriptor:[0,20],service_lifetime_enum:[0,20],service_provid:[0,20],service_provider_abc:[0,1,13,14,20],service_typ:7,servicecollect:7,servicecollectionabc:[7,13],servicedescriptor:7,servicelifetimeenum:7,serviceprovid:7,serviceproviderabc:[1,7,13,14],session:[5,6],set:[1,2,3,4,8,9,10,11,12,13,15],set_background_color:3,set_cursor_posit:3,set_execut:12,set_foreground_color:3,set_hold_back:3,set_runtime_directori:8,set_working_directori:8,settings_help:[13,20],settingshelp:15,setup:17,sh_cpl:20,show:3,shown:2,simpl:19,singleton:7,snake:12,sourc:[12,16,17],source_cr:[13,20],source_path:[15,17],sourcepath:15,spinner:3,spinner_background_color:3,spinner_foreground_color:3,spinner_thread:[0,20],spinnerthread:3,stage:8,standard:12,start:[16,17],start_servic:[13,20],start_tim:8,startservic:14,startup:[1,20],startup_abc:[0,13,20],startupabc:[1,13],stderr:12,stdout:12,stop:3,stop_spin:3,str:[2,3,5,6,8,9,10,12,13,15,16,17,18],string:[0,3,5,6,9,10,20],subject:10,submodul:[0,20],system:12,tabl:[3,12],templat:[17,18],template_build:[13,20],template_file_abc:18,templatebuild:18,templatefileabc:18,test:8,text_background_color:3,text_foreground_color:3,thi:19,thread:[3,16],time:[0,9,20],time_format:[9,11],time_format_set:[0,9,20],time_format_settings_names_enum:[0,20],timeformat:11,timeformatset:[9,11],timeformatsettingsnamesenum:11,to_dict:15,to_list:2,to_str:15,token:2,trace:9,traceback:3,transceiv:10,tree:9,trigger:16,tupl:[0,13,21],type:[1,2,7],understand:19,uninstal:12,uninstall_servic:[13,20],uninstallservic:14,union:[2,3,7],update_servic:[13,20],updateservic:14,upper:12,url:15,use:19,use_application_api:18,use_service_provid:18,use_startup:[1,18],used:1,user_nam:10,usernam:10,util:[0,20],valid:10,valu:[2,3,4,7,8,9,10,11,13,15],value_token:2,variabl:2,version:15,version_servic:[13,20],version_set:[13,20],version_settings_name_enum:[13,20],versioninfo:[0,13,21],versionservic:14,versionset:15,versionsettingsnameenum:15,warn:[9,13],watchdog:16,when:[3,16],white:3,work:8,working_directori:8,workspac:[14,18],workspace_set:[13,14,18,20],workspace_settings_name_enum:[13,20],workspaceset:[14,15,18],workspacesettingsnameenum:15,write:[3,9,17],write_at:3,write_lin:3,write_line_at:3,yellow:3,you:19,your:19},titles:["CPL","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","CPL_CLI","cpl_cli.command","cpl_cli.configuration","cpl_cli.live_server","cpl_cli.publish","cpl_cli.source_creator","Introduction to the CPL Docs","cpl","tests package"],titleterms:{add_servic:14,applic:1,application_abc:1,application_build:1,application_builder_abc:1,application_environ:8,application_environment_abc:8,background_color_enum:3,build_servic:14,build_set:15,build_settings_name_enum:15,cli:13,cli_set:13,cli_settings_name_enum:13,command:14,command_abc:13,command_handler_servic:13,command_model:13,common:[0,13,21],configur:[2,15],configuration_abc:2,configuration_model_abc:2,configuration_variable_name_enum:2,connect:5,consol:3,console_argu:2,console_build:18,console_cal:3,content:[0,13,21],context:6,cpl:[0,1,2,3,4,5,6,7,8,9,10,11,12,19,20],cpl_cli:[13,14,15,16,17,18],credential_manag:12,databas:[4,5,6],database_connect:5,database_connection_abc:5,database_context:6,database_context_abc:6,database_model:4,database_set:4,database_settings_name_enum:4,dependency_inject:7,doc:19,edraft:[0,13,21],email:10,email_client_abc:10,email_client_servic:10,email_client_set:10,email_client_settings_name_enum:10,environ:8,environment_name_enum:8,error:13,foreground_color_enum:3,generate_servic:14,help_servic:14,install_servic:14,introduct:19,librari:[0,13,21],library_build:18,live_serv:16,live_server_servic:16,live_server_thread:16,log:9,logger_abc:9,logger_servic:9,logging_level_enum:9,logging_set:9,logging_settings_name_enum:9,mail:10,main:13,manual:19,modul:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,21],new_servic:14,packag:21,pip:12,project_set:15,project_settings_name_enum:15,project_type_enum:15,publish:17,publish_servic:14,publisher_abc:17,publisher_servic:17,python:[0,13,21],remove_servic:14,service_collect:7,service_collection_abc:7,service_descriptor:7,service_lifetime_enum:7,service_provid:7,service_provider_abc:7,settings_help:15,sh_cpl:[0,13,21],source_cr:18,spinner_thread:3,start_servic:14,startup:13,startup_abc:1,string:12,submodul:4,template_build:18,test:21,time:11,time_format_set:11,time_format_settings_names_enum:11,uninstall_servic:14,update_servic:14,util:12,version_servic:14,version_set:15,version_settings_name_enum:15,workspace_set:15,workspace_settings_name_enum:15}})