sh_cpl/docs/build/html/searchindex.js

Search.setIndex({docnames:["cli.add","cli.build","cli.generate","cli.help","cli.install","cli.new","cli.overview","cli.publish","cli.remove","cli.start","cli.uninstall","cli.update","cli.version","contributing","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","getting_started","index","introduction","modules","quickstart","setup"],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:["cli.add.md","cli.build.md","cli.generate.md","cli.help.md","cli.install.md","cli.new.md","cli.overview.md","cli.publish.md","cli.remove.md","cli.start.md","cli.uninstall.md","cli.update.md","cli.version.md","contributing.md","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","getting_started.rst","index.rst","introduction.md","modules.rst","quickstart.md","setup.md"],objects:{"cpl.application":{application_abc:[15,0,0,"-"],application_builder:[15,0,0,"-"],application_builder_abc:[15,0,0,"-"],startup_abc:[15,0,0,"-"]},"cpl.application.application_abc":{ApplicationABC:[15,1,1,""]},"cpl.application.application_abc.ApplicationABC":{configure:[15,2,1,""],main:[15,2,1,""],run:[15,2,1,""]},"cpl.application.application_builder":{ApplicationBuilder:[15,1,1,""]},"cpl.application.application_builder.ApplicationBuilder":{build:[15,2,1,""],use_startup:[15,2,1,""]},"cpl.application.application_builder_abc":{ApplicationBuilderABC:[15,1,1,""]},"cpl.application.application_builder_abc.ApplicationBuilderABC":{build:[15,2,1,""],use_startup:[15,2,1,""]},"cpl.application.startup_abc":{StartupABC:[15,1,1,""]},"cpl.application.startup_abc.StartupABC":{configure_configuration:[15,2,1,""],configure_services:[15,2,1,""]},"cpl.configuration":{configuration:[16,0,0,"-"],configuration_abc:[16,0,0,"-"],configuration_model_abc:[16,0,0,"-"],configuration_variable_name_enum:[16,0,0,"-"],console_argument:[16,0,0,"-"]},"cpl.configuration.configuration":{Configuration:[16,1,1,""]},"cpl.configuration.configuration.Configuration":{add_configuration:[16,2,1,""],add_console_argument:[16,2,1,""],add_console_arguments:[16,2,1,""],add_environment_variables:[16,2,1,""],add_json_file:[16,2,1,""],additional_arguments:[16,2,1,""],argument_error_function:[16,2,1,""],environment:[16,2,1,""],get_configuration:[16,2,1,""]},"cpl.configuration.configuration_abc":{ConfigurationABC:[16,1,1,""]},"cpl.configuration.configuration_abc.ConfigurationABC":{add_configuration:[16,2,1,""],add_console_argument:[16,2,1,""],add_console_arguments:[16,2,1,""],add_environment_variables:[16,2,1,""],add_json_file:[16,2,1,""],additional_arguments:[16,2,1,""],argument_error_function:[16,2,1,""],environment:[16,2,1,""],get_configuration:[16,2,1,""]},"cpl.configuration.configuration_model_abc":{ConfigurationModelABC:[16,1,1,""]},"cpl.configuration.configuration_model_abc.ConfigurationModelABC":{from_dict:[16,2,1,""]},"cpl.configuration.configuration_variable_name_enum":{ConfigurationVariableNameEnum:[16,1,1,""]},"cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum":{customer:[16,3,1,""],environment:[16,3,1,""],name:[16,3,1,""],to_list:[16,2,1,""]},"cpl.configuration.console_argument":{ConsoleArgument:[16,1,1,""]},"cpl.configuration.console_argument.ConsoleArgument":{aliases:[16,2,1,""],console_arguments:[16,2,1,""],is_value_token_optional:[16,2,1,""],name:[16,2,1,""],token:[16,2,1,""],value_token:[16,2,1,""]},"cpl.console":{background_color_enum:[17,0,0,"-"],console:[17,0,0,"-"],console_call:[17,0,0,"-"],foreground_color_enum:[17,0,0,"-"],spinner_thread:[17,0,0,"-"]},"cpl.console.background_color_enum":{BackgroundColorEnum:[17,1,1,""]},"cpl.console.background_color_enum.BackgroundColorEnum":{"default":[17,3,1,""],blue:[17,3,1,""],cyan:[17,3,1,""],green:[17,3,1,""],grey:[17,3,1,""],magenta:[17,3,1,""],red:[17,3,1,""],white:[17,3,1,""],yellow:[17,3,1,""]},"cpl.console.console":{Console:[17,1,1,""]},"cpl.console.console.Console":{background_color:[17,3,1,""],banner:[17,2,1,""],clear:[17,2,1,""],close:[17,2,1,""],color_reset:[17,2,1,""],disable:[17,2,1,""],enable:[17,2,1,""],error:[17,2,1,""],foreground_color:[17,3,1,""],read:[17,2,1,""],read_line:[17,2,1,""],reset_cursor_position:[17,2,1,""],select:[17,2,1,""],set_background_color:[17,2,1,""],set_cursor_position:[17,2,1,""],set_foreground_color:[17,2,1,""],set_hold_back:[17,2,1,""],spinner:[17,2,1,""],table:[17,2,1,""],write:[17,2,1,""],write_at:[17,2,1,""],write_line:[17,2,1,""],write_line_at:[17,2,1,""]},"cpl.console.console_call":{ConsoleCall:[17,1,1,""]},"cpl.console.console_call.ConsoleCall":{"function":[17,2,1,""],args:[17,2,1,""]},"cpl.console.foreground_color_enum":{ForegroundColorEnum:[17,1,1,""]},"cpl.console.foreground_color_enum.ForegroundColorEnum":{"default":[17,3,1,""],blue:[17,3,1,""],cyan:[17,3,1,""],green:[17,3,1,""],grey:[17,3,1,""],magenta:[17,3,1,""],red:[17,3,1,""],white:[17,3,1,""],yellow:[17,3,1,""]},"cpl.console.spinner_thread":{SpinnerThread:[17,1,1,""]},"cpl.console.spinner_thread.SpinnerThread":{exit:[17,2,1,""],run:[17,2,1,""],stop_spinning:[17,2,1,""]},"cpl.database":{database_model:[18,0,0,"-"],database_settings:[18,0,0,"-"],database_settings_name_enum:[18,0,0,"-"]},"cpl.database.connection":{database_connection:[19,0,0,"-"],database_connection_abc:[19,0,0,"-"]},"cpl.database.connection.database_connection":{DatabaseConnection:[19,1,1,""]},"cpl.database.connection.database_connection.DatabaseConnection":{connect:[19,2,1,""],engine:[19,2,1,""],session:[19,2,1,""]},"cpl.database.connection.database_connection_abc":{DatabaseConnectionABC:[19,1,1,""]},"cpl.database.connection.database_connection_abc.DatabaseConnectionABC":{connect:[19,2,1,""],engine:[19,2,1,""],session:[19,2,1,""]},"cpl.database.context":{database_context:[20,0,0,"-"],database_context_abc:[20,0,0,"-"]},"cpl.database.context.database_context":{DatabaseContext:[20,1,1,""]},"cpl.database.context.database_context.DatabaseContext":{connect:[20,2,1,""],engine:[20,2,1,""],save_changes:[20,2,1,""],session:[20,2,1,""]},"cpl.database.context.database_context_abc":{DatabaseContextABC:[20,1,1,""]},"cpl.database.context.database_context_abc.DatabaseContextABC":{connect:[20,2,1,""],engine:[20,2,1,""],save_changes:[20,2,1,""],session:[20,2,1,""]},"cpl.database.database_settings":{DatabaseSettings:[18,1,1,""]},"cpl.database.database_settings.DatabaseSettings":{auth_plugin:[18,2,1,""],case_sensitive:[18,2,1,""],connection_string:[18,2,1,""],credentials:[18,2,1,""],echo:[18,2,1,""],encoding:[18,2,1,""],from_dict:[18,2,1,""]},"cpl.database.database_settings_name_enum":{DatabaseSettingsNameEnum:[18,1,1,""]},"cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum":{auth_plugin:[18,3,1,""],case_sensitive:[18,3,1,""],connection_string:[18,3,1,""],credentials:[18,3,1,""],echo:[18,3,1,""],encoding:[18,3,1,""]},"cpl.dependency_injection":{service_collection:[21,0,0,"-"],service_collection_abc:[21,0,0,"-"],service_descriptor:[21,0,0,"-"],service_lifetime_enum:[21,0,0,"-"],service_provider:[21,0,0,"-"],service_provider_abc:[21,0,0,"-"]},"cpl.dependency_injection.service_collection":{ServiceCollection:[21,1,1,""]},"cpl.dependency_injection.service_collection.ServiceCollection":{add_db_context:[21,2,1,""],add_logging:[21,2,1,""],add_scoped:[21,2,1,""],add_singleton:[21,2,1,""],add_transient:[21,2,1,""],build_service_provider:[21,2,1,""]},"cpl.dependency_injection.service_collection_abc":{ServiceCollectionABC:[21,1,1,""]},"cpl.dependency_injection.service_collection_abc.ServiceCollectionABC":{add_db_context:[21,2,1,""],add_logging:[21,2,1,""],add_scoped:[21,2,1,""],add_singleton:[21,2,1,""],add_transient:[21,2,1,""],build_service_provider:[21,2,1,""]},"cpl.dependency_injection.service_descriptor":{ServiceDescriptor:[21,1,1,""]},"cpl.dependency_injection.service_descriptor.ServiceDescriptor":{implementation:[21,2,1,""],lifetime:[21,2,1,""],service_type:[21,2,1,""]},"cpl.dependency_injection.service_lifetime_enum":{ServiceLifetimeEnum:[21,1,1,""]},"cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum":{"transient":[21,3,1,""],scoped:[21,3,1,""],singleton:[21,3,1,""]},"cpl.dependency_injection.service_provider":{ServiceProvider:[21,1,1,""]},"cpl.dependency_injection.service_provider.ServiceProvider":{build_service:[21,2,1,""],get_service:[21,2,1,""]},"cpl.dependency_injection.service_provider_abc":{ServiceProviderABC:[21,1,1,""]},"cpl.dependency_injection.service_provider_abc.ServiceProviderABC":{build_service:[21,2,1,""],get_service:[21,2,1,""]},"cpl.environment":{application_environment:[22,0,0,"-"],application_environment_abc:[22,0,0,"-"],environment_name_enum:[22,0,0,"-"]},"cpl.environment.application_environment":{ApplicationEnvironment:[22,1,1,""]},"cpl.environment.application_environment.ApplicationEnvironment":{application_name:[22,2,1,""],customer:[22,2,1,""],date_time_now:[22,2,1,""],end_time:[22,2,1,""],environment_name:[22,2,1,""],host_name:[22,2,1,""],runtime_directory:[22,2,1,""],set_runtime_directory:[22,2,1,""],set_working_directory:[22,2,1,""],start_time:[22,2,1,""],working_directory:[22,2,1,""]},"cpl.environment.application_environment_abc":{ApplicationEnvironmentABC:[22,1,1,""]},"cpl.environment.application_environment_abc.ApplicationEnvironmentABC":{application_name:[22,2,1,""],customer:[22,2,1,""],date_time_now:[22,2,1,""],end_time:[22,2,1,""],environment_name:[22,2,1,""],host_name:[22,2,1,""],runtime_directory:[22,2,1,""],set_runtime_directory:[22,2,1,""],set_working_directory:[22,2,1,""],start_time:[22,2,1,""],working_directory:[22,2,1,""]},"cpl.environment.environment_name_enum":{EnvironmentNameEnum:[22,1,1,""]},"cpl.environment.environment_name_enum.EnvironmentNameEnum":{development:[22,3,1,""],production:[22,3,1,""],staging:[22,3,1,""],testing:[22,3,1,""]},"cpl.logging":{logger_abc:[23,0,0,"-"],logger_service:[23,0,0,"-"],logging_level_enum:[23,0,0,"-"],logging_settings:[23,0,0,"-"],logging_settings_name_enum:[23,0,0,"-"]},"cpl.logging.logger_abc":{LoggerABC:[23,1,1,""]},"cpl.logging.logger_abc.LoggerABC":{debug:[23,2,1,""],error:[23,2,1,""],fatal:[23,2,1,""],header:[23,2,1,""],info:[23,2,1,""],trace:[23,2,1,""],warn:[23,2,1,""]},"cpl.logging.logger_service":{Logger:[23,1,1,""]},"cpl.logging.logger_service.Logger":{create:[23,2,1,""],debug:[23,2,1,""],error:[23,2,1,""],fatal:[23,2,1,""],header:[23,2,1,""],info:[23,2,1,""],trace:[23,2,1,""],warn:[23,2,1,""]},"cpl.logging.logging_level_enum":{LoggingLevelEnum:[23,1,1,""]},"cpl.logging.logging_level_enum.LoggingLevelEnum":{DEBUG:[23,3,1,""],ERROR:[23,3,1,""],FATAL:[23,3,1,""],INFO:[23,3,1,""],OFF:[23,3,1,""],TRACE:[23,3,1,""],WARN:[23,3,1,""]},"cpl.logging.logging_settings":{LoggingSettings:[23,1,1,""]},"cpl.logging.logging_settings.LoggingSettings":{console:[23,2,1,""],filename:[23,2,1,""],from_dict:[23,2,1,""],level:[23,2,1,""],path:[23,2,1,""]},"cpl.logging.logging_settings_name_enum":{LoggingSettingsNameEnum:[23,1,1,""]},"cpl.logging.logging_settings_name_enum.LoggingSettingsNameEnum":{console_level:[23,3,1,""],file_level:[23,3,1,""],filename:[23,3,1,""],path:[23,3,1,""]},"cpl.mailing":{email:[24,0,0,"-"],email_client_abc:[24,0,0,"-"],email_client_service:[24,0,0,"-"],email_client_settings:[24,0,0,"-"],email_client_settings_name_enum:[24,0,0,"-"]},"cpl.mailing.email":{EMail:[24,1,1,""]},"cpl.mailing.email.EMail":{add_header:[24,2,1,""],add_receiver:[24,2,1,""],body:[24,2,1,""],check_mail:[24,2,1,""],get_content:[24,2,1,""],header:[24,2,1,""],header_list:[24,2,1,""],receiver:[24,2,1,""],receiver_list:[24,2,1,""],subject:[24,2,1,""],transceiver:[24,2,1,""]},"cpl.mailing.email_client_abc":{EMailClientABC:[24,1,1,""]},"cpl.mailing.email_client_abc.EMailClientABC":{connect:[24,2,1,""],send_mail:[24,2,1,""]},"cpl.mailing.email_client_service":{EMailClient:[24,1,1,""]},"cpl.mailing.email_client_service.EMailClient":{connect:[24,2,1,""],create:[24,2,1,""],login:[24,2,1,""],send_mail:[24,2,1,""]},"cpl.mailing.email_client_settings":{EMailClientSettings:[24,1,1,""]},"cpl.mailing.email_client_settings.EMailClientSettings":{credentials:[24,2,1,""],from_dict:[24,2,1,""],host:[24,2,1,""],port:[24,2,1,""],user_name:[24,2,1,""]},"cpl.mailing.email_client_settings_name_enum":{EMailClientSettingsNameEnum:[24,1,1,""]},"cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum":{credentials:[24,3,1,""],host:[24,3,1,""],port:[24,3,1,""],user_name:[24,3,1,""]},"cpl.time":{time_format_settings:[25,0,0,"-"],time_format_settings_names_enum:[25,0,0,"-"]},"cpl.time.time_format_settings":{TimeFormatSettings:[25,1,1,""]},"cpl.time.time_format_settings.TimeFormatSettings":{date_format:[25,2,1,""],date_time_format:[25,2,1,""],date_time_log_format:[25,2,1,""],from_dict:[25,2,1,""],time_format:[25,2,1,""]},"cpl.time.time_format_settings_names_enum":{TimeFormatSettingsNamesEnum:[25,1,1,""]},"cpl.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum":{date_format:[25,3,1,""],date_time_format:[25,3,1,""],date_time_log_format:[25,3,1,""],time_format:[25,3,1,""]},"cpl.utils":{credential_manager:[26,0,0,"-"],pip:[26,0,0,"-"],string:[26,0,0,"-"]},"cpl.utils.credential_manager":{CredentialManager:[26,1,1,""]},"cpl.utils.credential_manager.CredentialManager":{build_string:[26,2,1,""],decrypt:[26,2,1,""],encrypt:[26,2,1,""]},"cpl.utils.pip":{Pip:[26,1,1,""]},"cpl.utils.pip.Pip":{get_executable:[26,2,1,""],get_outdated:[26,2,1,""],get_package:[26,2,1,""],install:[26,2,1,""],reset_executable:[26,2,1,""],set_executable:[26,2,1,""],uninstall:[26,2,1,""]},"cpl.utils.string":{String:[26,1,1,""]},"cpl.utils.string.String":{convert_to_camel_case:[26,2,1,""],convert_to_snake_case:[26,2,1,""],first_to_lower:[26,2,1,""],first_to_upper:[26,2,1,""],random_string:[26,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},terms:{"abstract":[2,15,16,19,20,21,22,23,24],"byte":26,"case":[13,26,32],"char":[17,26],"class":[2,15,16,17,18,19,20,21,22,23,24,25,26],"default":[17,33],"enum":[2,16,17,18,21,22,23,24,25],"function":[17,26,32],"import":[13,32],"int":[17,26,32],"new":[6,13,17,27,31,32,33],"public":13,"return":[16,17,21,24,32],"short":[3,6],"static":[16,24,26],"transient":21,"true":16,"while":13,Adding:13,For:13,IDE:32,Such:13,That:13,The:[1,2,4,5,6,7,8,10,13,21,24,26,29,30,32,33],These:29,Useful:[17,26],With:6,__init__:32,__main__:32,__name__:32,abc:[2,15,16,17,19,20,21,22,23,24],abl:13,about:[29,33],absolut:6,accept:13,activ:17,add:[5,6,13,16,21,24,27,31,32],add_configur:16,add_console_argu:16,add_db_context:21,add_environment_vari:16,add_head:24,add_json_fil:16,add_log:21,add_receiv:24,add_scop:21,add_singleton:21,add_transi:21,added:0,addit:[6,13],additional_argu:16,address:24,agre:13,alia:6,alias:[6,16],all:[1,7,8,12,13],allow:13,alreadi:[13,32,33],also:[32,33],ani:[6,17],api:[13,29,30,31],app:[1,6,15,28,29,30,31,32],appli:13,applic:[5,9,14,17,22,23,24,29,30,31,32,33],application_abc:[14,31],application_build:[14,31],application_builder_abc:[14,31],application_environ:[14,31],application_environment_abc:[14,23,24,31],application_nam:22,applicationabc:15,applicationbuild:15,applicationbuilderabc:15,applicationenviron:22,applicationenvironmentabc:[22,23,24],appropri:13,appset:[15,32],arg:[15,17,20,26],argument:[1,5,6,7,16,17,26,27,31],argument_error_funct:16,artifact:6,ascii_lett:32,ascii_lowercas:32,ascii_uppercas:32,ask:13,attribut:[16,18,23,24,25],auth_plugin:18,authplugin:18,automat:13,avail:[3,6,13],back:[13,17],background:17,background_color:17,background_color_enum:[14,31],backgroundcolorenum:17,banner:17,base64:26,base:[2,15,16,17,18,19,20,21,22,23,24,25,26,32],basic:[27,31,32,33],been:13,befor:[13,17],behavior:13,better:13,bit:13,blue:17,bodi:24,bool:[16,17,24],branch:13,build:[6,7,8,15,26,27,31,32,33],build_servic:21,build_service_provid:21,build_str:26,call:[0,15,17],callabl:[16,17,21],camel:26,camelcas:26,can:[0,1,6,7,8,13,29,33],case_sensit:18,casesensit:18,chang:[6,9,13,20,32],channel:13,charact:17,check:24,check_mail:24,checkout:13,chnage:33,choic:32,citizen:13,classmethod:[17,26],clear:17,cli:[12,28,29,30,31,32],close:[13,17],code:[32,33],codebas:13,collect:[16,17,21],color:17,color_reset:17,command:[0,1,3,5,7,8,13,26,27,31,33],commandnameoralia:6,commit:13,common:[29,30],commun:13,complex:[29,30],config:[15,21],configmodel:2,configur:[14,15,18,21,23,24,25,31],configuration_abc:[14,15,21,31],configuration_model_abc:[14,18,23,24,25,31],configuration_variable_name_enum:[14,31],configurationabc:[15,16,21],configurationmodelabc:[16,18,23,24,25],configurationvariablenameenum:16,configure_configur:15,configure_servic:15,confirm:13,connect:[14,18,20,24,31],connection_str:[18,19,20],connectionstr:18,consid:13,consist:13,consol:[1,3,5,6,7,8,14,16,23,28,31,32],console_argu:[14,31],console_cal:[14,31],console_level:23,consoleargu:16,consolecal:17,consoleloglevel:23,contain:15,content:[27,28,31],context:[14,18,21,31,33],continu:32,contributor:13,convert:[16,23,24,25,26],convert_to_camel_cas:26,convert_to_snake_cas:26,coordin:[13,17],copi:1,core:[19,20],count:13,cpl:[6,14,27,28,33],craft:13,creat:[6,7,8,13,15,21,23,24,26,28,29,30,31],credenti:[18,24,26],credential_manag:[14,31],credentialmanag:26,current:[6,22],cursor:17,cursor_background_color:17,cursor_foreground_color:17,custom:[15,16,22],cyan:17,data:[7,8],databas:[14,21,31],database_connect:[14,18,31],database_connection_abc:[14,18,31],database_context:[14,18,31],database_context_abc:[14,18,21,31],database_model:[14,31],database_set:[14,19,20,21,31],database_settings_name_enum:[14,31],databaseconnect:19,databaseconnectionabc:19,databasecontext:20,databasecontextabc:[20,21],databaseset:[18,19,20,21],databasesettingsnameenum:18,date_format:25,date_time_format:25,date_time_log_format:25,date_time_now:22,dateformat:25,datetimeformat:25,datetimelogformat:25,db_context:21,db_context_typ:21,db_set:21,debug:23,declin:33,decod:26,decrypt:26,def:32,defin:[6,16,33],delet:8,deped:4,depend:[6,11,32],dependency_inject:[14,15,31],describ:13,descript:[6,27,31],descriptor:21,design:13,desktop:[29,30],detail:29,determin:13,develop:[6,13,22,29,30,32,33],dict:[16,17,18,23,24,25],directli:[1,13],directori:[1,6,7,8,22,32],disabl:17,discuss:13,dist:[6,7],doc:[19,20],document:13,doesn:13,don:[13,32],done:32,duplic:13,each:6,echo:18,edit:13,edraft:[13,33],effici:[29,30],effort:13,either:6,element:17,elif:32,email:[14,31],email_client_abc:[14,31],email_client_servic:[14,31],email_client_set:[14,31],email_client_settings_name_enum:[14,31],emailcli:24,emailclientabc:24,emailclientset:24,emailclientsettingsnameenum:24,emul:32,enabl:[17,32],encod:[18,26],encrypt:26,end:[17,23],end_tim:22,engin:[19,20],enough:13,ensur:13,enter:33,enterpris:[29,30],entri:[15,17],enumer:[16,17,18,21,22,23,24,25],env:23,environ:[14,16,23,24,28,31],environment_nam:22,environment_name_enum:[14,31],environmentnameenum:22,error:[16,17,23],essenti:[13,32],even:13,everyth:29,except:23,execut:[1,6,7,8,26],exist:13,exit:[17,32],explor:32,extra:[26,33],extract:13,fatal:23,featur:33,file:[1,2,6,7,8,9,13,16,33],file_level:23,fileloglevel:23,filenam:23,find:13,first:[6,13,26,29,30],first_to_low:26,first_to_upp:26,fix:13,fixup:13,folder:32,follow:[6,13,32,33],fore:33,foreground:17,foreground_color:17,foreground_color_enum:[14,31],foregroundcolorenum:17,fork:13,format:[6,23,25],forth:13,found:16,from:[0,6,7,8,10,12,13,15,16,18,29,30,32],from_dict:[16,18,23,24,25],full:32,gener:[5,6,7,8,27,31,32,33],generate_password:32,get:[26,29,30,31,33],get_configur:16,get_cont:24,get_execut:26,get_outd:26,get_packag:26,get_servic:21,git:13,gitea:13,give:13,given:[0,1,4,6,7,10,16,17,18,21,26],going:13,good:13,great:29,green:17,grei:17,guid:13,handl:[17,26],hard:13,has:[0,17],have:[6,13,32,33],haven:13,head:13,header:[17,23,24],header_background_color:17,header_foreground_color:17,header_list:24,hear:13,hello:[32,33],help:[6,13,27,29,30,31],here:[13,33],hold:17,host:24,host_nam:22,html:[19,20],http:[19,20,33],immedi:6,implement:[13,21],includ:[1,13,33],index:[26,32,33],info:[13,23],inform:[13,23,33],initi:[5,28,31],inject:32,input:[17,32],instal:[6,12,26,27,28,31,32],instanc:[15,21],instance_typ:21,interact:17,intern:21,introduc:32,invalid:16,investig:13,is_value_token_opt:16,isol:13,issus:13,its:[6,13],join:32,json:[7,8,16,32,33],keep:13,kei:33,key_typ:16,keyword:17,known:16,kwarg:17,languag:[27,31],larger:13,last:17,launch:33,learn:[29,30,33],len:32,length:[17,26,32],letter:32,level:23,lib:33,librari:[1,5,6,7,8,28,29,30,31],licens:32,lifetim:21,like:[13,32],line:[13,17,32],list:[3,6,12,16,17,21,24,26],live:33,load:15,local:[26,28,31],log:[14,24,31],logfil:23,logger:[21,23,24],logger_abc:[14,24,31],logger_servic:[14,31],loggerabc:[23,24],logging_level_enum:[14,31],logging_set:[14,31],logging_settings_name_enum:[14,31],logginglevelenum:23,loggingset:23,loggingsettingsnameenum:23,login:24,look:32,love:13,lower:[26,32],magenta:17,mail:[14,31],mail_set:24,main:[15,32],maintain:13,major:13,make:[13,33],manag:13,master:13,mayb:13,meant:[29,30],member:13,menu:[17,28,31],messag:[3,17,23],method:13,might:13,mind:13,minim:13,mit:13,more:[13,33],most:[6,32,33],msg_len:17,must:[0,1,6,13],name:[0,1,2,5,6,7,8,16,22,23,26,33],navig:33,need:[13,32,33],next:[17,28,31],none:[16,17,21,23,24,26],note:13,object:[15,16,17,21,24,26],occur:16,off:23,often:13,on_blu:17,on_cyan:17,on_default:17,on_green:17,on_grei:17,on_magenta:17,on_r:17,on_whit:17,on_yellow:17,one:13,onli:32,open:[13,32,33],option:[6,13,16,17,21,23,24,26,32],option_background_color:17,option_foreground_color:17,optionalsarg:6,order:13,org:[19,20],origin:13,otherwis:0,ouput:32,our:13,out:[13,32,33],outdat:26,outlin:13,output:[1,6,7,16,17,32,33],outsid:13,overview:[27,31,33],own:6,packag:[4,5,6,10,12,26,28,29,30,31,32],page:29,parent:6,password:32,patch:13,path:[0,1,7,16,22,23,27,31,33],pep:13,pip:[4,10,12,14,31,32,33],place:16,platform:[29,30],pleas:13,point:[13,15,17],port:24,posit:17,possibl:13,prefix:[6,16],prepar:[1,6,7,13,15],prerequisit:[28,31],press:33,prevent:13,print:[17,32],problem:13,proce:13,process:13,product:22,program:23,project:[0,1,4,6,7,8,10,11,13,27,28,31,33],projectmain:32,prompt:33,properti:[16,17,18,19,20,21,22,23,24,25],propos:13,provid:[13,15,21,32,33],publish:[1,6,8,27,31,33],push:13,pycharm:32,pyhton:33,python:[1,13,26,29,30,32,33],question:13,quickli:13,random:[26,32],random_str:26,rang:32,read:[16,17,32],read_lin:17,readi:[13,33],readili:13,readm:32,realli:13,receiv:24,receiver_list:24,red:17,refer:[0,29,30,31],referenc:0,rel:[27,31],relat:13,remov:[0,6,7,27,31],replac:26,repo:13,repositori:13,repres:[17,18,22,24],represent:[19,20,21,23,24,25],reproduc:13,reproduct:13,requir:13,requiredarg:6,reserv:13,reset:[17,26],reset_cursor_posit:17,reset_execut:26,restart:[6,9,33],result:[24,26],right:13,root:6,run:[1,5,15,17,26,32,33],runtim:22,runtime_directori:22,same:6,sampl:32,save:[13,16,20],save_chang:20,scenario:13,schemat:[27,31],scope:21,search:[13,16,21],search_typ:16,section:32,see:[5,13,19,20,32,33],select:[17,32],send:[13,24],send_mail:24,serv:6,server:[6,24,29,30,33],servic:[2,15,21,23,24,32],service_collect:[14,31],service_collection_abc:[14,31],service_descriptor:[14,31],service_lifetime_enum:[14,31],service_provid:[14,31],service_provider_abc:[14,15,31],service_typ:21,servicecollect:21,servicecollectionabc:21,servicedescriptor:21,servicelifetimeenum:21,serviceprovid:21,serviceproviderabc:[15,21],session:[19,20],set:[2,15,16,17,18,21,22,23,24,25,26,28,31,32],set_background_color:17,set_cursor_posit:17,set_execut:26,set_foreground_color:17,set_hold_back:17,set_runtime_directori:22,set_working_directori:22,setup:[6,7,8,30,33],sh_cpl:[13,33],should:[16,32,33],show:[3,17],shown:[6,16,33],significantli:13,similar:33,simpl:[5,29,30,33],singleton:21,size:13,small:13,snake:26,snake_cas:26,some:6,sometim:13,soon:13,sourc:[0,1,7,8,13,26,32,33],specifi:[0,6,16],spinner:17,spinner_background_color:17,spinner_foreground_color:17,spinner_thread:[14,31],spinnerthread:17,sqlalchemi:[19,20],src:32,stage:22,standard:26,start:[6,27,29,30,31],start_tim:22,startup:15,startup_abc:[14,31],startupabc:15,statement:6,stderr:26,stdout:26,step:13,stop:17,stop_spin:17,store:16,str:[0,1,2,3,4,5,7,8,10,16,17,19,20,22,23,24,26,32],string:[14,17,19,20,23,24,31,32],style:13,subject:24,submodul:[14,31],subprocess:26,success:33,successfulli:13,suppli:6,sure:13,syntax:[27,31],system:26,tabl:[17,26,27,28,31],take:[6,16],target:[0,1],team:13,termin:[6,17,32,33],test:[13,22,32],text:17,text_background_color:17,text_foreground_color:17,than:13,thank:13,them:1,themselv:13,thi:[3,13,15,29,30,32,33],those:33,thread:[2,17],through:32,throughout:13,thrown:23,time:[13,14,23,31],time_format:[23,25],time_format_set:[14,23,31],time_format_settings_names_enum:[14,31],timeformat:25,timeformatset:[23,25],timeformatsettingsnamesenum:25,to_list:16,todai:13,token:16,topic:13,trace:23,traceback:17,tracker:13,transceiv:24,tree:23,tutori:[32,33],type:[0,1,2,3,4,7,8,10,15,16,21,27,31],ultim:13,under:13,understand:[13,29,30,32,33],unfortun:13,uninstal:[6,26,27,31],union:[16,17,21],unit:13,updat:[6,13,27,31],upfront:13,upper:[26,32],url:[26,33],use:[0,6,15,24,29,30,32,33],use_startup:15,used:[1,7,8,15],user:32,user_nam:24,usernam:24,uses:32,util:[14,31],valid:[24,32],valu:[0,1,2,3,4,5,7,8,10,16,17,18,21,22,23,24,25],value_token:16,variabl:[16,26],version:[6,27,31],via:[4,10,13],walk:32,want:[13,32],warn:23,watch:33,wealth:13,welcom:32,well:13,what:[28,31],when:17,whether:16,which:[0,6,16,17,26,33],white:17,who:13,window:33,within:[1,6,13],without:[4,6,13],work:[6,13,22],workaround:13,workflow:[27,31],working_directori:22,workspac:[0,1,5,6,8,28,31],world:[32,33],would:13,write:[13,17,23],write_at:17,write_lin:[17,32],write_line_at:17,yellow:17,you:[0,1,6,13,29,30,32,33],your:[4,6,9,13,29,30,33]},titles:["cpl add","cpl build","cpl generate","cpl help","cpl install","cpl new","CLI Overview and Command Reference","cpl publish","cpl remove","cpl start","cpl uninstall","cpl update","cpl version","Contributing to CPL","API Reference","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","CLI Reference","Getting started","Introduction to the CPL Docs","Introduction to the CPL Docs","cpl","Getting started with CPL","Setting up the local environment and workspace"],titleterms:{"new":5,add:0,address:13,api:14,app:33,applic:15,application_abc:15,application_build:15,application_builder_abc:15,application_environ:22,application_environment_abc:22,argument:[0,2,3,4,8,10],background_color_enum:17,basic:6,bug:13,build:1,cli:[6,27,33],code:13,command:6,configur:16,configuration_abc:16,configuration_model_abc:16,configuration_variable_name_enum:16,connect:19,consol:[17,33],console_argu:16,console_cal:17,content:[0,1,2,4,5,6,7,8,10,32,33],context:20,contribut:13,cpl:[0,1,2,3,4,5,7,8,9,10,11,12,13,15,16,17,18,19,20,21,22,23,24,25,26,29,30,31,32],creat:[32,33],credential_manag:26,databas:[18,19,20],database_connect:19,database_connection_abc:19,database_context:20,database_context_abc:20,database_model:18,database_set:18,database_settings_name_enum:18,dependency_inject:21,descript:[0,1,2,3,4,5,7,8,10],doc:[29,30],email:24,email_client_abc:24,email_client_servic:24,email_client_set:24,email_client_settings_name_enum:24,environ:[22,33],environment_name_enum:22,explor:30,featur:13,feedback:13,foreground_color_enum:17,found:13,gener:2,get:[28,32],guidelin:13,help:3,initi:33,instal:[4,33],introduct:[29,30],issu:13,languag:6,librari:33,licens:13,local:33,log:23,logger_abc:23,logger_servic:23,logging_level_enum:23,logging_set:23,logging_settings_name_enum:23,mail:24,manual:29,menu:32,next:[32,33],overview:6,packag:33,path:6,pip:26,prerequisit:[32,33],project:[5,32],publish:7,pull:13,refer:[6,14,27],rel:6,remov:8,request:13,review:13,rule:13,schemat:[2,6],service_collect:21,service_collection_abc:21,service_descriptor:21,service_lifetime_enum:21,service_provid:21,service_provider_abc:21,set:33,spinner_thread:17,start:[9,28,32,33],startup_abc:15,string:26,submiss:13,submit:13,submodul:18,syntax:6,tabl:[6,32,33],time:25,time_format_set:25,time_format_settings_names_enum:25,type:5,uninstal:10,updat:11,util:26,version:12,what:[32,33],workflow:6,workspac:33}})