mlonmcu.environment package

Submodules

mlonmcu.environment.config module

class mlonmcu.environment.config.BackendConfig(name, enabled=True, features={})

Bases: BaseConfig

class mlonmcu.environment.config.BackendFeatureConfig(name, backend, supported=True)

Bases: FeatureConfig

class mlonmcu.environment.config.BaseConfig

Bases: object

class mlonmcu.environment.config.DefaultsConfig(log_level=20, log_to_file=False, log_rotate=False, default_framework=None, default_backends={}, default_target=None, cleanup_auto=False, cleanup_keep=100)

Bases: BaseConfig

class mlonmcu.environment.config.FeatureConfig(name, kind=FeatureKind.UNKNOWN, supported=True)

Bases: object

class mlonmcu.environment.config.FeatureKind(value)

Bases: Enum

An enumeration.

BACKEND = 2

FRAMEWORK = 1

FRONTEND = 4

TARGET = 3

UNKNOWN = 0

class mlonmcu.environment.config.FrameworkConfig(name, enabled=True, backends={}, features={})

Bases: BaseConfig

class mlonmcu.environment.config.FrameworkFeatureConfig(name, framework, supported=True)

Bases: FeatureConfig

class mlonmcu.environment.config.FrontendConfig(name, enabled=True, features={})

Bases: BaseConfig

class mlonmcu.environment.config.FrontendFeatureConfig(name, frontend, supported=True)

Bases: FeatureConfig

class mlonmcu.environment.config.PathConfig(path, base=None)

Bases: BaseConfig

class mlonmcu.environment.config.PlatformConfig(name, enabled=True, features={})

Bases: BaseConfig

class mlonmcu.environment.config.PlatformFeatureConfig(name, platform, supported=True)

Bases: FeatureConfig

class mlonmcu.environment.config.RepoConfig(url, ref=None, options=None)

Bases: BaseConfig

property recursive

property single_branch

property submodules

class mlonmcu.environment.config.TargetConfig(name, enabled=True, features={})

Bases: BaseConfig

class mlonmcu.environment.config.TargetFeatureConfig(name, target, supported=True)

Bases: FeatureConfig

mlonmcu.environment.config.get_config_dir()

mlonmcu.environment.config.get_environments_dir()

mlonmcu.environment.config.get_environments_file()

mlonmcu.environment.config.get_plugins_dir()

mlonmcu.environment.config.init_config_dir()

mlonmcu.environment.environment module

class mlonmcu.environment.environment.DefaultEnvironment

Bases: Environment

class mlonmcu.environment.environment.Environment

Bases: object

classmethod from_file(filename)

get_default_backends(framework)

get_default_frameworks()

get_default_targets()

has_backend(name)

has_feature(name)

An alias for supports_feature.

has_framework(name)

has_frontend(name)

has_platform(name)

has_target(name)

has_toolchain(name)

property home

Home directory of mlonmcu environment.

lookup_backend_configs(backend=None, framework=None, names_only=False)

lookup_backend_feature_configs(name=None, framework=None, backend=None)

lookup_feature_configs(name=None, kind=None, frontend=None, framework=None, backend=None, platform=None, target=None)

lookup_framework_configs(framework=None, names_only=False)

lookup_framework_feature_configs(name=None, framework=None)

lookup_frontend_configs(frontend=None, names_only=False)

lookup_frontend_feature_configs(name=None, frontend=None)

lookup_path(name)

lookup_platform_configs(platform=None, names_only=False)

lookup_platform_feature_configs(name=None, platform=None)

lookup_target_configs(target=None, names_only=False)

lookup_target_feature_configs(name=None, target=None)

lookup_var(name, default=None)

supports_feature(name)

to_file(filename)

class mlonmcu.environment.environment.UserEnvironment(home, merge=False, alias=None, defaults=None, paths=None, repos=None, frameworks=None, frontends=None, platforms=None, toolchains=None, targets=None, variables=None, default_flags=None)

Bases: DefaultEnvironment

mlonmcu.environment.init module

mlonmcu.environment.init.clone_models_repo(dest, url=None, ref=None, refresh=False, recursive=False)

mlonmcu.environment.init.create_environment_directories(path, directories)

mlonmcu.environment.init.create_venv_directory(base, hidden=True)

mlonmcu.environment.init.initialize_environment(directory, name, interactive=True, create_venv=None, clone_models=None, allow_exists=None, register=None, template=None, config=None)

mlonmcu.environment.list module

mlonmcu.environment.list.get_alternative_name(name, names)

mlonmcu.environment.list.get_environment_names()

mlonmcu.environment.list.get_environments_map()

mlonmcu.environment.list.register_environment(name, path, overwrite=False)

mlonmcu.environment.list.validate_name(name)

mlonmcu.environment.loader module

mlonmcu.environment.loader.load_environment_from_file(filename, base)

Utility to initialize a mlonmcu environment from a YAML file.

mlonmcu.environment.templates module

Definitions of mlonmcu config templates.

mlonmcu.environment.templates.fill_environment_yaml(template_name, home_dir, config=None)

mlonmcu.environment.templates.fill_template(name, data={})

mlonmcu.environment.templates.get_template_names()

mlonmcu.environment.templates.get_template_text(name)

mlonmcu.environment.templates.write_environment_yaml_from_template(path, template_name, home_dir, config=None)

mlonmcu.environment.writer module

mlonmcu.environment.writer.create_environment_dict(environment)

mlonmcu.environment.writer.write_environment_to_file(environment, filename)

Utility to initialize a mlonmcu environment from a YAML file.

Module contents