Dotfiles API¶
dotfiles
Subpackages¶
- dotfiles.cli package
- dotfiles.venv package
- Objectives
- Configuration
- Submodules
- dotfiles.venv.ipython_config module
str_center()in_venv_ipyconfig()logevent()ConfigExceptionStepExceptionStepConfigExceptionprepend_comment_char()get_pyver()get___WRK_default()get_WORKON_HOME_default()VenvJSONEncoderCmdAliasIpyAliasCdAliasCdAlias.VENV_IPYMAGICS_FILE_HEADERCdAlias.VENV_IPYMAGIC_METHOD_TEMPLATECdAlias.VENV_IPYMAGICS_FOOTERCdAlias.to_ipython_method()CdAlias.VIM_HEADER_TEMPLATECdAlias.VIM_CD_FUNCTION_TEMPLATECdAlias.VIM_CD_COMMAND_TEMPLATECdAlias.VIM_EDIT_FUNCTION_TEMPLATECdAlias.VIM_EDIT_COMMAND_TEMPLATECdAlias.vim_cmd_nameCdAlias.vim_cmd_namesCdAlias.to_vim_function()CdAlias.BASH_CDALIAS_HEADERCdAlias.BASH_FUNCTION_TEMPLATECdAlias.BASH_ALIAS_TEMPLATECdAlias.BASH_COMPLETION_TEMPLATECdAlias.bash_func_nameCdAlias.bash_func_namesCdAlias.to_bash_function()CdAlias.to_shell_str()
StepPrintEnvStepPrintEnvStderrStepStepBuilderlookup_from_kwargs_env()build_dotfiles_env()build_virtualenvwrapper_env()build_conda_env()build_conda_cfg_env()build_venv_paths_full_env()build_venv_paths_cdalias_env()build_user_aliases_env()build_usrlog_env()build_venv_activate_env()Envshell_quote()shell_varquote()VenvVenv.build()Venv.parse_VENVSTR()Venv.aliasesVenv.configure_sys()Venv.workon()Venv.configure_ipython()Venv.generate_vars_env()Venv.generate_bash_env()Venv.generate_bash_cdalias()Venv.generate_vim_cdalias()Venv.generate_venv_ipymagics()Venv.project_filesVenv.PROJECT_FILESVenv.system()Venv.open_editors()Venv.open_terminals()Venv.to_dict()Venv.to_json()Venv.update_os_environ()Venv.call()
get_IPYTHON_ALIAS_DEFAULTS()get_IPYTHON_ALIAS_OVERLAY()get_USRLOG_ALIAS_OVERLAY()ipython_main()ipython_imports()VenvTestUtilsVenvTestCaseTest_001_lookupTest_100_EnvTest_200_StepBuilderTest_250_VenvTest_250_Venv.setUp()Test_250_Venv.test_000_venv_test_fixture()Test_250_Venv.test_010_assert_venv_requires_VENVPREFIX__or__VIRTUAL_ENV()Test_250_Venv.test_100_Venv_parse_VENVSTR_env__and__VENVSTR()Test_250_Venv.test_110_Venv_parse_VENVSTR_VENVSTR()Test_250_Venv.test_120_Venv_parse_VENVSTR_VENVSTR_VENVSTRAPP()
Test_300_venv_build_envTest_300_venv_build_env.setUp()Test_300_venv_build_env.print_()Test_300_venv_build_env.test_100_build_dotfiles_env()Test_300_venv_build_env.test_200_build_usrlog_env()Test_300_venv_build_env.test_400_build_virtualenvwrapper_env()Test_300_venv_build_env.test_500_build_conda_env()Test_300_venv_build_env.test_600_build_conda_cfg_env()Test_300_venv_build_env.test_600_build_venv_paths_full_env__prefix_None()Test_300_venv_build_env.test_610_build_venv_paths_full_env__prefix_root()Test_300_venv_build_env.test_620_build_venv_paths_full_env__prefix_None()Test_300_venv_build_env.test_650_build_venv_paths_cdalias_env()
Test_500_VenvTest_900_Venv_mainTest_900_Venv_main.setUp()Test_900_Venv_main.test_001_main_null()Test_900_Venv_main.test_100_main()Test_900_Venv_main.test_110_main_VENVSTR()Test_900_Venv_main.test_120_main_print_bash_VENVSTR()Test_900_Venv_main.test_130_main_print_bash_VENVSTR_VENVSTRAPP()Test_900_Venv_main.test_140_main_VENVSTR_WORKON_HOME()Test_900_Venv_main.test_200_main_print_bash_VENVSTR__APP()Test_900_Venv_main.test_200_main_print_bash()Test_900_Venv_main.test_210_main_print_bash_aliases()Test_900_Venv_main.test_220_main_print_bash_cdaliases()Test_900_Venv_main.test_300_main_print_zsh()Test_900_Venv_main.test_400_main_print_vim()
build_venv_arg_parser()comment_comment()main()
- dotfiles.venv.ipython_magics module
magics_class()line_magic()VenvMagicsVenvMagics.cd()VenvMagics.cdhome()VenvMagics.cdh()VenvMagics.cdwrk()VenvMagics.cddotfiles()VenvMagics.cdd()VenvMagics.cdprojecthome()VenvMagics.cdp()VenvMagics.cdph()VenvMagics.cdworkonhome()VenvMagics.cdwh()VenvMagics.cdve()VenvMagics.cdcondaenvspath()VenvMagics.cda()VenvMagics.cdce()VenvMagics.cdvirtualenv()VenvMagics.cdv()VenvMagics.cdsrc()VenvMagics.cds()VenvMagics.cdwrd()VenvMagics.cdw()VenvMagics.cdbin()VenvMagics.cdb()VenvMagics.cdetc()VenvMagics.cde()VenvMagics.cdlib()VenvMagics.cdl()VenvMagics.cdlog()VenvMagics.cdpylib()VenvMagics.cdpysite()VenvMagics.cdsitepackages()VenvMagics.cdvar()VenvMagics.cdwww()VenvMagics.cdww()VenvMagics.cdhelp()VenvMagics.dotfiles_status()VenvMagics.ds()VenvMagics.dotfiles_reload()VenvMagics.dr()
main()
- dotfiles.venv.venv module
str_center()in_venv_ipyconfig()logevent()ConfigExceptionStepExceptionStepConfigExceptionprepend_comment_char()get_pyver()get___WRK_default()get_WORKON_HOME_default()VenvJSONEncoderCmdAliasIpyAliasCdAliasCdAlias.VENV_IPYMAGICS_FILE_HEADERCdAlias.VENV_IPYMAGIC_METHOD_TEMPLATECdAlias.VENV_IPYMAGICS_FOOTERCdAlias.to_ipython_method()CdAlias.VIM_HEADER_TEMPLATECdAlias.VIM_CD_FUNCTION_TEMPLATECdAlias.VIM_CD_COMMAND_TEMPLATECdAlias.VIM_EDIT_FUNCTION_TEMPLATECdAlias.VIM_EDIT_COMMAND_TEMPLATECdAlias.vim_cmd_nameCdAlias.vim_cmd_namesCdAlias.to_vim_function()CdAlias.BASH_CDALIAS_HEADERCdAlias.BASH_FUNCTION_TEMPLATECdAlias.BASH_ALIAS_TEMPLATECdAlias.BASH_COMPLETION_TEMPLATECdAlias.bash_func_nameCdAlias.bash_func_namesCdAlias.to_bash_function()CdAlias.to_shell_str()
StepPrintEnvStepPrintEnvStderrStepStepBuilderlookup_from_kwargs_env()build_dotfiles_env()build_virtualenvwrapper_env()build_conda_env()build_conda_cfg_env()build_venv_paths_full_env()build_venv_paths_cdalias_env()build_user_aliases_env()build_usrlog_env()build_venv_activate_env()Envshell_quote()shell_varquote()VenvVenv.build()Venv.parse_VENVSTR()Venv.aliasesVenv.configure_sys()Venv.workon()Venv.configure_ipython()Venv.generate_vars_env()Venv.generate_bash_env()Venv.generate_bash_cdalias()Venv.generate_vim_cdalias()Venv.generate_venv_ipymagics()Venv.project_filesVenv.PROJECT_FILESVenv.system()Venv.open_editors()Venv.open_terminals()Venv.to_dict()Venv.to_json()Venv.update_os_environ()Venv.call()
get_IPYTHON_ALIAS_DEFAULTS()get_IPYTHON_ALIAS_OVERLAY()get_USRLOG_ALIAS_OVERLAY()ipython_main()ipython_imports()VenvTestUtilsVenvTestCaseTest_001_lookupTest_100_EnvTest_200_StepBuilderTest_250_VenvTest_250_Venv.setUp()Test_250_Venv.test_000_venv_test_fixture()Test_250_Venv.test_010_assert_venv_requires_VENVPREFIX__or__VIRTUAL_ENV()Test_250_Venv.test_100_Venv_parse_VENVSTR_env__and__VENVSTR()Test_250_Venv.test_110_Venv_parse_VENVSTR_VENVSTR()Test_250_Venv.test_120_Venv_parse_VENVSTR_VENVSTR_VENVSTRAPP()
Test_300_venv_build_envTest_300_venv_build_env.setUp()Test_300_venv_build_env.print_()Test_300_venv_build_env.test_100_build_dotfiles_env()Test_300_venv_build_env.test_200_build_usrlog_env()Test_300_venv_build_env.test_400_build_virtualenvwrapper_env()Test_300_venv_build_env.test_500_build_conda_env()Test_300_venv_build_env.test_600_build_conda_cfg_env()Test_300_venv_build_env.test_600_build_venv_paths_full_env__prefix_None()Test_300_venv_build_env.test_610_build_venv_paths_full_env__prefix_root()Test_300_venv_build_env.test_620_build_venv_paths_full_env__prefix_None()Test_300_venv_build_env.test_650_build_venv_paths_cdalias_env()
Test_500_VenvTest_900_Venv_mainTest_900_Venv_main.setUp()Test_900_Venv_main.test_001_main_null()Test_900_Venv_main.test_100_main()Test_900_Venv_main.test_110_main_VENVSTR()Test_900_Venv_main.test_120_main_print_bash_VENVSTR()Test_900_Venv_main.test_130_main_print_bash_VENVSTR_VENVSTRAPP()Test_900_Venv_main.test_140_main_VENVSTR_WORKON_HOME()Test_900_Venv_main.test_200_main_print_bash_VENVSTR__APP()Test_900_Venv_main.test_200_main_print_bash()Test_900_Venv_main.test_210_main_print_bash_aliases()Test_900_Venv_main.test_220_main_print_bash_cdaliases()Test_900_Venv_main.test_300_main_print_zsh()Test_900_Venv_main.test_400_main_print_vim()
build_venv_arg_parser()comment_comment()main()
- dotfiles.venv.venv_ipyconfig module
str_center()in_venv_ipyconfig()logevent()ConfigExceptionStepExceptionStepConfigExceptionprepend_comment_char()get_pyver()get___WRK_default()get_WORKON_HOME_default()VenvJSONEncoderCmdAliasIpyAliasCdAliasCdAlias.VENV_IPYMAGICS_FILE_HEADERCdAlias.VENV_IPYMAGIC_METHOD_TEMPLATECdAlias.VENV_IPYMAGICS_FOOTERCdAlias.to_ipython_method()CdAlias.VIM_HEADER_TEMPLATECdAlias.VIM_CD_FUNCTION_TEMPLATECdAlias.VIM_CD_COMMAND_TEMPLATECdAlias.VIM_EDIT_FUNCTION_TEMPLATECdAlias.VIM_EDIT_COMMAND_TEMPLATECdAlias.vim_cmd_nameCdAlias.vim_cmd_namesCdAlias.to_vim_function()CdAlias.BASH_CDALIAS_HEADERCdAlias.BASH_FUNCTION_TEMPLATECdAlias.BASH_ALIAS_TEMPLATECdAlias.BASH_COMPLETION_TEMPLATECdAlias.bash_func_nameCdAlias.bash_func_namesCdAlias.to_bash_function()CdAlias.to_shell_str()
StepPrintEnvStepPrintEnvStderrStepStepBuilderlookup_from_kwargs_env()build_dotfiles_env()build_virtualenvwrapper_env()build_conda_env()build_conda_cfg_env()build_venv_paths_full_env()build_venv_paths_cdalias_env()build_user_aliases_env()build_usrlog_env()build_venv_activate_env()Envshell_quote()shell_varquote()VenvVenv.build()Venv.parse_VENVSTR()Venv.aliasesVenv.configure_sys()Venv.workon()Venv.configure_ipython()Venv.generate_vars_env()Venv.generate_bash_env()Venv.generate_bash_cdalias()Venv.generate_vim_cdalias()Venv.generate_venv_ipymagics()Venv.project_filesVenv.PROJECT_FILESVenv.system()Venv.open_editors()Venv.open_terminals()Venv.to_dict()Venv.to_json()Venv.update_os_environ()Venv.call()
get_IPYTHON_ALIAS_DEFAULTS()get_IPYTHON_ALIAS_OVERLAY()get_USRLOG_ALIAS_OVERLAY()ipython_main()ipython_imports()VenvTestUtilsVenvTestCaseTest_001_lookupTest_100_EnvTest_200_StepBuilderTest_250_VenvTest_250_Venv.setUp()Test_250_Venv.test_000_venv_test_fixture()Test_250_Venv.test_010_assert_venv_requires_VENVPREFIX__or__VIRTUAL_ENV()Test_250_Venv.test_100_Venv_parse_VENVSTR_env__and__VENVSTR()Test_250_Venv.test_110_Venv_parse_VENVSTR_VENVSTR()Test_250_Venv.test_120_Venv_parse_VENVSTR_VENVSTR_VENVSTRAPP()
Test_300_venv_build_envTest_300_venv_build_env.setUp()Test_300_venv_build_env.print_()Test_300_venv_build_env.test_100_build_dotfiles_env()Test_300_venv_build_env.test_200_build_usrlog_env()Test_300_venv_build_env.test_400_build_virtualenvwrapper_env()Test_300_venv_build_env.test_500_build_conda_env()Test_300_venv_build_env.test_600_build_conda_cfg_env()Test_300_venv_build_env.test_600_build_venv_paths_full_env__prefix_None()Test_300_venv_build_env.test_610_build_venv_paths_full_env__prefix_root()Test_300_venv_build_env.test_620_build_venv_paths_full_env__prefix_None()Test_300_venv_build_env.test_650_build_venv_paths_cdalias_env()
Test_500_VenvTest_900_Venv_mainTest_900_Venv_main.setUp()Test_900_Venv_main.test_001_main_null()Test_900_Venv_main.test_100_main()Test_900_Venv_main.test_110_main_VENVSTR()Test_900_Venv_main.test_120_main_print_bash_VENVSTR()Test_900_Venv_main.test_130_main_print_bash_VENVSTR_VENVSTRAPP()Test_900_Venv_main.test_140_main_VENVSTR_WORKON_HOME()Test_900_Venv_main.test_200_main_print_bash_VENVSTR__APP()Test_900_Venv_main.test_200_main_print_bash()Test_900_Venv_main.test_210_main_print_bash_aliases()Test_900_Venv_main.test_220_main_print_bash_cdaliases()Test_900_Venv_main.test_300_main_print_zsh()Test_900_Venv_main.test_400_main_print_vim()
build_venv_arg_parser()comment_comment()main()
- dotfiles.venv.venv_ipymagics module
magics_class()line_magic()ipymagic_quote()VenvMagicsVenvMagics.cd()VenvMagics.cdhome()VenvMagics.cdh()VenvMagics.cdwrk()VenvMagics.cddotfiles()VenvMagics.cdd()VenvMagics.cdprojecthome()VenvMagics.cdp()VenvMagics.cdph()VenvMagics.cdworkonhome()VenvMagics.cdwh()VenvMagics.cdve()VenvMagics.cdcondaenvspath()VenvMagics.cda()VenvMagics.cdce()VenvMagics.cdcondaroot()VenvMagics.cdr()VenvMagics.cdvirtualenv()VenvMagics.cdv()VenvMagics.cdsrc()VenvMagics.cds()VenvMagics.cdwrd()VenvMagics.cdw()VenvMagics.cdbin()VenvMagics.cdb()VenvMagics.cdetc()VenvMagics.cde()VenvMagics.cdlib()VenvMagics.cdl()VenvMagics.cdlog()VenvMagics.cdpylib()VenvMagics.cdpysite()VenvMagics.cdsitepackages()VenvMagics.cdvar()VenvMagics.cdwww()VenvMagics.cdww()VenvMagics.cdhelp()VenvMagics.dotfiles_status()VenvMagics.ds()VenvMagics.dotfiles_reload()VenvMagics.dr()
main()