Public APIΒΆ
import kloch
""" functions """
kloch.get_cli(...)
# Return the command line interface generated from user arguments provided.
""" classes """
kloch.BaseParser(...)
# The root CLI parser who's all subparsers use as base.
kloch.Environ(...)
# Global list of supported environment variables.
kloch.HubConfig(...)
# Options determining how the hub must be installed.
kloch.HubInstallFilesystem(...)
# Represent the filesystem structure of a hub installation.
kloch.OS(...)
# Current operating system.
""" modules """
kloch.config
# A simple configuration system for the Knots-hub runtime.
kloch.constants
# Variables that are constants through the app runtime.
kloch.filesystem
# manipulate the filesystem
kloch.installer
# various software that can be installed on the user system
""" other """
- Configuration
- Constants
- Command Line Interface
- Installers
BaseVendorInstaller
BaseVendorInstaller.__init__()
BaseVendorInstaller.dirs_to_make
BaseVendorInstaller.install()
BaseVendorInstaller.install_dir
BaseVendorInstaller.is_installed
BaseVendorInstaller.make_install_directories()
BaseVendorInstaller.name()
BaseVendorInstaller.set_install_completed()
BaseVendorInstaller.time_installed
BaseVendorInstaller.uninstall()
BaseVendorInstaller.version
BaseVendorInstaller.version_installed
HubInstallersList
RezVendorInstaller
create_exe_shortcut()
install_hub()
is_hub_up_to_date()
read_vendor_installers_from_file()
uninstall_hub()
update_hub()
- Filesystem
HubInstallFilesystem
HubInstallFilesystem.__init__()
HubInstallFilesystem.current_exe_new
HubInstallFilesystem.current_exe_old
HubInstallFilesystem.current_exe_src
HubInstallFilesystem.expected_exe_new
HubInstallFilesystem.expected_exe_old
HubInstallFilesystem.expected_exe_src
HubInstallFilesystem.hubinstall_path
HubInstallFilesystem.install_new_dir
HubInstallFilesystem.install_old_dir
HubInstallFilesystem.install_src_dir
HubInstallFilesystem.installed_time
HubInstallFilesystem.is_installed
HubInstallFilesystem.last_executable
HubInstallFilesystem.log_path
HubInstallFilesystem.root
find_hub_executable()
get_expected_hub_executable()
rmtree()