Public APIΒΆ

import kloch

""" functions """
kloch.deepmerge_dicts(...)
# Recursively merge the 2 given dict "over one another".

kloch.get_all_profile_file_paths(...)
# Get all the environment-profile file paths as registred by the user.

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

kloch.get_config(...)
# Get the current kloch configuration extracted from the environment.

kloch.get_profile_file_path(...)
# Get the filesystem location to the profile(s) with the given name.

kloch.read_profile_from_file(...)
# Generate an instance from a serialized file on disk.

kloch.read_profile_from_id(...)
# Generate a profile instance from a serialized file on disk retrieved using the given identifier.

kloch.refacto_dict(...)
# Iterate through all key/value pairs of the given dict and execute the given callback

kloch.run_cli(...)
# Execute the CLI based on the provided user arguments.

kloch.serialize_profile(...)
# Convert the instance to a serialized dictionnary intended to be written on disk.

kloch.write_profile_to_file(...)
# Convert the instance to a serialized file on disk.


""" classes """
kloch.Environ(...)
# Environment variables used across the application.

kloch.EnvironmentProfile(...)
# A profile is a collection of parameters required to start a pre-defined launcher.

kloch.KlochConfig(...)
# Configure kloch using a simple key/value pair dataclass system.

kloch.MergeRule(...)
# Define how 2 python objects should be merged together.

kloch.MergeableDict(...)
# A dict that can be deep-merged with another dict.


""" modules """
kloch.config
# A simple configuration system for the Kloch runtime.

kloch.filesyntax
# Serialization and unserialization of environment profile to disk.

kloch.launchers
# Entities that serialize a function call made to execute a software.


""" other """