API reference

• cpl_core.application package
  • Submodules
  • cpl_core.application.application_abc module
    • ApplicationABC
      • ApplicationABC.configure()
      • ApplicationABC.main()
      • ApplicationABC.run()
      • ApplicationABC.run_async()
  • cpl_core.application.application_builder module
    • ApplicationBuilder
      • ApplicationBuilder.build()
      • ApplicationBuilder.build_async()
      • ApplicationBuilder.use_extension()
      • ApplicationBuilder.use_startup()
  • cpl_core.application.application_builder_abc module
    • ApplicationBuilderABC
      • ApplicationBuilderABC.build()
      • ApplicationBuilderABC.build_async()
      • ApplicationBuilderABC.use_startup()
  • cpl_core.application.application_extension_abc module
    • ApplicationExtensionABC
      • ApplicationExtensionABC.run()
  • cpl_core.application.startup_abc module
    • StartupABC
      • StartupABC.configure_configuration()
      • StartupABC.configure_services()
  • cpl_core.application.startup_extension_abc module
    • StartupExtensionABC
      • StartupExtensionABC.configure_configuration()
      • StartupExtensionABC.configure_services()
  • Module contents
    • cpl-core CPL core
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.micro
      • VersionInfo.minor
• cpl_core.configuration package
  • Submodules
  • cpl_core.configuration.argument_abc module
    • ArgumentABC
      • ArgumentABC.add_console_argument()
      • ArgumentABC.aliases
      • ArgumentABC.console_arguments
      • ArgumentABC.name
      • ArgumentABC.prevent_next_executable
      • ArgumentABC.token
  • cpl_core.configuration.argument_builder module
    • ArgumentBuilder
      • ArgumentBuilder.build_argument()
  • cpl_core.configuration.argument_executable_abc module
    • ArgumentExecutableABC
      • ArgumentExecutableABC.run()
  • cpl_core.configuration.argument_type_enum module
    • ArgumentTypeEnum
      • ArgumentTypeEnum.Executable
      • ArgumentTypeEnum.Flag
      • ArgumentTypeEnum.Variable
  • cpl_core.configuration.configuration module
    • Configuration
      • Configuration.add_configuration()
      • Configuration.add_console_argument()
      • Configuration.add_environment_variables()
      • Configuration.add_json_file()
      • Configuration.additional_arguments
      • Configuration.argument_error_function
      • Configuration.arguments
      • Configuration.create_console_argument()
      • Configuration.environment
      • Configuration.for_each_argument()
      • Configuration.get_configuration()
      • Configuration.parse_console_arguments()
  • cpl_core.configuration.configuration_abc module
    • ConfigurationABC
      • ConfigurationABC.add_configuration()
      • ConfigurationABC.add_console_argument()
      • ConfigurationABC.add_environment_variables()
      • ConfigurationABC.add_json_file()
      • ConfigurationABC.additional_arguments
      • ConfigurationABC.argument_error_function
      • ConfigurationABC.arguments
      • ConfigurationABC.create_console_argument()
      • ConfigurationABC.environment
      • ConfigurationABC.for_each_argument()
      • ConfigurationABC.get_configuration()
      • ConfigurationABC.parse_console_arguments()
  • cpl_core.configuration.configuration_model_abc module
    • ConfigurationModelABC
      • ConfigurationModelABC.from_dict()
    • base_func()
  • cpl_core.configuration.configuration_variable_name_enum module
    • ConfigurationVariableNameEnum
      • ConfigurationVariableNameEnum.customer
      • ConfigurationVariableNameEnum.environment
      • ConfigurationVariableNameEnum.name
      • ConfigurationVariableNameEnum.to_list()
  • cpl_core.configuration.executable_argument module
    • ExecutableArgument
      • ExecutableArgument.executable_type
      • ExecutableArgument.run()
      • ExecutableArgument.set_executable()
      • ExecutableArgument.validators
  • cpl_core.configuration.flag_argument module
    • FlagArgument
  • cpl_core.configuration.validator_abc module
    • ValidatorABC
      • ValidatorABC.validate()
  • cpl_core.configuration.variable_argument module
    • VariableArgument
      • VariableArgument.set_value()
      • VariableArgument.value
      • VariableArgument.value_token
  • Module contents
    • cpl-core CPL core
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.micro
      • VersionInfo.minor
• cpl_core.console package
  • Submodules
  • cpl_core.console.background_color_enum module
    • BackgroundColorEnum
      • BackgroundColorEnum.blue
      • BackgroundColorEnum.cyan
      • BackgroundColorEnum.default
      • BackgroundColorEnum.green
      • BackgroundColorEnum.grey
      • BackgroundColorEnum.magenta
      • BackgroundColorEnum.red
      • BackgroundColorEnum.white
      • BackgroundColorEnum.yellow
  • cpl_core.console.console module
    • Console
      • Console.background_color
      • Console.banner()
      • Console.clear()
      • Console.close()
      • Console.color_reset()
      • Console.disable()
      • Console.enable()
      • Console.error()
      • Console.foreground_color
      • Console.read()
      • Console.read_line()
      • Console.reset_cursor_position()
      • Console.select()
      • Console.set_background_color()
      • Console.set_cursor_position()
      • Console.set_foreground_color()
      • Console.set_hold_back()
      • Console.spinner()
      • Console.table()
      • Console.write()
      • Console.write_at()
      • Console.write_line()
      • Console.write_line_at()
  • cpl_core.console.console_call module
    • ConsoleCall
      • ConsoleCall.args
      • ConsoleCall.function
  • cpl_core.console.foreground_color_enum module
    • ForegroundColorEnum
      • ForegroundColorEnum.blue
      • ForegroundColorEnum.cyan
      • ForegroundColorEnum.default
      • ForegroundColorEnum.green
      • ForegroundColorEnum.grey
      • ForegroundColorEnum.magenta
      • ForegroundColorEnum.red
      • ForegroundColorEnum.white
      • ForegroundColorEnum.yellow
  • cpl_core.console.spinner_thread module
    • SpinnerThread
      • SpinnerThread.exit()
      • SpinnerThread.run()
      • SpinnerThread.stop_spinning()
  • Module contents
    • cpl-core CPL core
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.micro
      • VersionInfo.minor
• cpl_core.database package
  • Subpackages
    • cpl_core.database.connection package
      • Submodules
      • cpl_core.database.connection.database_connection module
      • cpl_core.database.connection.database_connection_abc module
      • Module contents
    • cpl_core.database.context package
      • Submodules
      • cpl_core.database.context.database_context module
      • cpl_core.database.context.database_context_abc module
      • Module contents
  • Submodules
  • cpl_core.database.database_settings module
    • DatabaseSettings
      • DatabaseSettings.auth_plugin
      • DatabaseSettings.buffered
      • DatabaseSettings.charset
      • DatabaseSettings.database
      • DatabaseSettings.host
      • DatabaseSettings.password
      • DatabaseSettings.port
      • DatabaseSettings.use_unicode
      • DatabaseSettings.user
  • cpl_core.database.database_settings_name_enum module
    • DatabaseSettingsNameEnum
      • DatabaseSettingsNameEnum.auth_plugin
      • DatabaseSettingsNameEnum.buffered
      • DatabaseSettingsNameEnum.charset
      • DatabaseSettingsNameEnum.database
      • DatabaseSettingsNameEnum.host
      • DatabaseSettingsNameEnum.password
      • DatabaseSettingsNameEnum.port
      • DatabaseSettingsNameEnum.use_unicode
      • DatabaseSettingsNameEnum.user
  • cpl_core.database.table_abc module
    • TableABC
      • TableABC.created_at
      • TableABC.delete_string
      • TableABC.insert_string
      • TableABC.modified_at
      • TableABC.udpate_string
  • Module contents
    • cpl-core CPL core
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.micro
      • VersionInfo.minor
• cpl_core.dependency_injection package
  • Submodules
  • cpl_core.dependency_injection.scope module
    • Scope
      • Scope.dispose()
      • Scope.service_provider
  • cpl_core.dependency_injection.scope_abc module
    • ScopeABC
      • ScopeABC.dispose()
      • ScopeABC.service_provider
  • cpl_core.dependency_injection.scope_builder module
    • ScopeBuilder
      • ScopeBuilder.build()
  • cpl_core.dependency_injection.service_collection module
    • ServiceCollection
      • ServiceCollection.add_db_context()
      • ServiceCollection.add_logging()
      • ServiceCollection.add_pipes()
      • ServiceCollection.add_scoped()
      • ServiceCollection.add_singleton()
      • ServiceCollection.add_transient()
      • ServiceCollection.build_service_provider()
  • cpl_core.dependency_injection.service_collection_abc module
    • ServiceCollectionABC
      • ServiceCollectionABC.add_db_context()
      • ServiceCollectionABC.add_discord()
      • ServiceCollectionABC.add_logging()
      • ServiceCollectionABC.add_pipes()
      • ServiceCollectionABC.add_scoped()
      • ServiceCollectionABC.add_singleton()
      • ServiceCollectionABC.add_transient()
      • ServiceCollectionABC.add_translation()
      • ServiceCollectionABC.build_service_provider()
  • cpl_core.dependency_injection.service_descriptor module
    • ServiceDescriptor
      • ServiceDescriptor.base_type
      • ServiceDescriptor.implementation
      • ServiceDescriptor.lifetime
      • ServiceDescriptor.service_type
  • cpl_core.dependency_injection.service_lifetime_enum module
    • ServiceLifetimeEnum
      • ServiceLifetimeEnum.scoped
      • ServiceLifetimeEnum.singleton
      • ServiceLifetimeEnum.transient
  • cpl_core.dependency_injection.service_provider module
    • ServiceProvider
      • ServiceProvider.build_by_signature()
      • ServiceProvider.build_service()
      • ServiceProvider.create_scope()
      • ServiceProvider.get_service()
      • ServiceProvider.get_services()
      • ServiceProvider.set_scope()
  • cpl_core.dependency_injection.service_provider_abc module
    • ServiceProviderABC
      • ServiceProviderABC.build_by_signature()
      • ServiceProviderABC.build_service()
      • ServiceProviderABC.create_scope()
      • ServiceProviderABC.get_service()
      • ServiceProviderABC.get_services()
      • ServiceProviderABC.inject()
      • ServiceProviderABC.set_global_provider()
      • ServiceProviderABC.set_scope()
  • Module contents
    • cpl-core CPL core
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.micro
      • VersionInfo.minor
• cpl_core.environment package
  • Submodules
  • cpl_core.environment.application_environment module
    • ApplicationEnvironment
      • ApplicationEnvironment.application_name
      • ApplicationEnvironment.customer
      • ApplicationEnvironment.date_time_now
      • ApplicationEnvironment.end_time
      • ApplicationEnvironment.environment_name
      • ApplicationEnvironment.host_name
      • ApplicationEnvironment.runtime_directory
      • ApplicationEnvironment.set_runtime_directory()
      • ApplicationEnvironment.set_working_directory()
      • ApplicationEnvironment.start_time
      • ApplicationEnvironment.working_directory
  • cpl_core.environment.application_environment_abc module
    • ApplicationEnvironmentABC
      • ApplicationEnvironmentABC.application_name
      • ApplicationEnvironmentABC.customer
      • ApplicationEnvironmentABC.date_time_now
      • ApplicationEnvironmentABC.end_time
      • ApplicationEnvironmentABC.environment_name
      • ApplicationEnvironmentABC.host_name
      • ApplicationEnvironmentABC.runtime_directory
      • ApplicationEnvironmentABC.set_runtime_directory()
      • ApplicationEnvironmentABC.set_working_directory()
      • ApplicationEnvironmentABC.start_time
      • ApplicationEnvironmentABC.working_directory
  • cpl_core.environment.environment_name_enum module
    • EnvironmentNameEnum
      • EnvironmentNameEnum.development
      • EnvironmentNameEnum.production
      • EnvironmentNameEnum.staging
      • EnvironmentNameEnum.testing
  • Module contents
    • cpl-core CPL core
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.micro
      • VersionInfo.minor
• cpl_core.logging package
  • Submodules
  • cpl_core.logging.logger_abc module
    • LoggerABC
      • LoggerABC.debug()
      • LoggerABC.error()
      • LoggerABC.fatal()
      • LoggerABC.header()
      • LoggerABC.info()
      • LoggerABC.trace()
      • LoggerABC.warn()
  • cpl_core.logging.logger_service module
    • Logger
      • Logger.create()
      • Logger.debug()
      • Logger.error()
      • Logger.fatal()
      • Logger.header()
      • Logger.info()
      • Logger.trace()
      • Logger.warn()
  • cpl_core.logging.logging_level_enum module
    • LoggingLevelEnum
      • LoggingLevelEnum.DEBUG
      • LoggingLevelEnum.ERROR
      • LoggingLevelEnum.FATAL
      • LoggingLevelEnum.INFO
      • LoggingLevelEnum.OFF
      • LoggingLevelEnum.TRACE
      • LoggingLevelEnum.WARN
  • cpl_core.logging.logging_settings module
    • LoggingSettings
      • LoggingSettings.console
      • LoggingSettings.filename
      • LoggingSettings.level
      • LoggingSettings.path
  • cpl_core.logging.logging_settings_name_enum module
    • LoggingSettingsNameEnum
      • LoggingSettingsNameEnum.console_level
      • LoggingSettingsNameEnum.file_level
      • LoggingSettingsNameEnum.filename
      • LoggingSettingsNameEnum.path
  • Module contents
    • cpl-core CPL core
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.micro
      • VersionInfo.minor
• cpl_core.mailing package
  • Submodules
  • cpl_core.mailing.email module
    • EMail
      • EMail.add_header()
      • EMail.add_receiver()
      • EMail.body
      • EMail.check_mail()
      • EMail.get_content()
      • EMail.header
      • EMail.header_list
      • EMail.receiver
      • EMail.receiver_list
      • EMail.subject
      • EMail.transceiver
  • cpl_core.mailing.email_client_abc module
    • EMailClientABC
      • EMailClientABC.connect()
      • EMailClientABC.send_mail()
  • cpl_core.mailing.email_client_service module
    • EMailClient
      • EMailClient.connect()
      • EMailClient.create()
      • EMailClient.login()
      • EMailClient.send_mail()
  • cpl_core.mailing.email_client_settings module
    • EMailClientSettings
      • EMailClientSettings.credentials
      • EMailClientSettings.host
      • EMailClientSettings.port
      • EMailClientSettings.user_name
  • cpl_core.mailing.email_client_settings_name_enum module
    • EMailClientSettingsNameEnum
      • EMailClientSettingsNameEnum.credentials
      • EMailClientSettingsNameEnum.host
      • EMailClientSettingsNameEnum.port
      • EMailClientSettingsNameEnum.user_name
  • Module contents
    • cpl-core CPL core
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.micro
      • VersionInfo.minor
• cpl_core.pipes package
  • Submodules
  • cpl_core.pipes.bool_pipe module
    • BoolPipe
      • BoolPipe.transform()
  • cpl_core.pipes.first_char_to_lower_pipe module
    • FirstCharToLowerPipe
      • FirstCharToLowerPipe.transform()
  • cpl_core.pipes.first_to_upper_pipe module
    • FirstToUpperPipe
      • FirstToUpperPipe.transform()
  • cpl_core.pipes.ip_address_pipe module
    • IPAddressPipe
      • IPAddressPipe.transform()
  • cpl_core.pipes.pipe_abc module
    • PipeABC
      • PipeABC.transform()
  • cpl_core.pipes.to_camel_case_pipe module
    • ToCamelCasePipe
      • ToCamelCasePipe.transform()
  • cpl_core.pipes.to_snake_case_pipe module
    • ToSnakeCasePipe
      • ToSnakeCasePipe.transform()
  • cpl_core.pipes.version_pipe module
    • VersionPipe
      • VersionPipe.transform()
  • Module contents
    • cpl-core CPL core
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.micro
      • VersionInfo.minor
• cpl_core.time package
  • Submodules
  • cpl_core.time.time_format_settings module
    • TimeFormatSettings
      • TimeFormatSettings.date_format
      • TimeFormatSettings.date_time_format
      • TimeFormatSettings.date_time_log_format
      • TimeFormatSettings.time_format
  • cpl_core.time.time_format_settings_names_enum module
    • TimeFormatSettingsNamesEnum
      • TimeFormatSettingsNamesEnum.date_format
      • TimeFormatSettingsNamesEnum.date_time_format
      • TimeFormatSettingsNamesEnum.date_time_log_format
      • TimeFormatSettingsNamesEnum.time_format
  • Module contents
    • cpl-core CPL core
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.micro
      • VersionInfo.minor
• cpl_core.utils package
  • Submodules
  • cpl_core.utils.credential_manager module
    • CredentialManager
      • CredentialManager.build_string()
      • CredentialManager.decrypt()
      • CredentialManager.encrypt()
  • cpl_core.utils.pip module
    • Pip
      • Pip.get_executable()
      • Pip.get_outdated()
      • Pip.get_package()
      • Pip.install()
      • Pip.reset_executable()
      • Pip.set_executable()
      • Pip.uninstall()
  • cpl_core.utils.string module
    • String
      • String.convert_to_camel_case()
      • String.convert_to_snake_case()
      • String.first_to_lower()
      • String.first_to_upper()
      • String.random_string()
  • Module contents
    • cpl-core CPL core
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.micro
      • VersionInfo.minor