Module brane_cli::utils

Contains useful utilities used throughout the brane-cli package.

Enums

• DependencyError
  If a dependency is not met, this enum lists which one and why not.

Functions

• assert_valid_bakery_name
  Checks whether the given string is a valid name for Bakery.
• check_dependencies
  Edited: Now returning UtilErrors.
• determine_file
  Edited: now returning CliErrors.
• determine_kind
  Edited: not taking a context anymore, returning CliErrors and a PackageKind instead of a string.
• ensure_config_dir
  Makes sure that Brane’s config directory exists and then returns its path.
• ensure_data_dir
  Makes sure that Brane’s data directory exists, and then returns its path.
• ensure_dataset_dir
  Makes sure that the dataset directory for the given dataset exists, then returns the path to it.
• ensure_datasets_dir
  Makes sure that Brane’s dataset directory exists, and then returns its path.
  Basically, tries to resolve the folder ~/.local/share/brane/data.
• ensure_history_file
  Makes sure that the history file exists and then returns its path.
• ensure_instance_dir
  Gets the directory where we store the instance definition for the given instance and ensures it exists.
• ensure_instances_dir
  Gets the directory where we store instance definitions and ensures it exists.
• ensure_package_dir
  Makes sure that the package directory for the given name/version pair exists, then returns the path to it.
  If the given version is omitted, just returns the package directory for this name.
  If the given version is latest, tries to find the latest version directory to return that; otherwise, always errors (regardless of ‘create’).
• ensure_packages_dir
  Makes sure that Brane’s packages directory exists, and then returns its path.
  Basically, tries to resolve the folder ’~/.local/share/brane/packages`.
• get_active_instance_link
  Returns the path for the softlink that points to the active instance directory.
• get_config_dir
  Edited: uses dirs instead of appdirs and returns UtilErrors when it goes wrong.
• get_data_dir
  Returns the general data directory based on the user’s home folder.
• get_dataset_dir
  Gets the directory where we likely stored a dataset.
  Does not guarantee that the directory also exists; check ensure_dataset_dir() for that.
• get_datasets_dir
  Returns the general data directory based on the user’s home folder.
  Basically, tries to resolve the folder ~/.local/share/brane/data.
  Note that this does not mean that this directory exists.
• get_history_file
  Edited: Now returns UtilErrors.
• get_instance_dir
  Gets the directory where we store the instance definition for the given instance.
• get_instances_dir
  Gets the directory where we store instance definitions.
• get_package_dir
  Edited: Now returning UtilErrors.
• get_packages_dir
  Edited: Changed to return UtilErrors.
• uppercase_first_letter
  Returns an equivalent string to the given one, except that the first letter is capitalized.