Public APIΒΆ

import kloch

""" functions """
kloch.get_cli(...)
# Return the command line interface generated from user arguments provided.

kloch.is_hub_up_to_date(...)
# Return True if the current hub version doesn't need update.

kloch.is_runtime_from_local_install(...)
# Find if the current runtime code is executed from a local hub installation.


""" 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.HubLocalFilesystem(...)
# Collection of paths for storing runtime data

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 """