core.cli package

Submodules

core.cli.configuring module

VIKI: more than a GUI for ROS, https://github.com/UT-RAM/viki version: 0.2 - Alice copyright: Robin Hoogervorst, Alex Kamphuis, Cees Trouwborst, 2016 licensed under the MIT License

class core.cli.configuring.Configuring

Class which will run the configuration for the user especially useful the first time

ask_config_option(option, value)

run()

core.cli.dependencies module

VIKI: more than a GUI for ROS, https://github.com/UT-RAM/viki version: 0.2 - Alice copyright: Robin Hoogervorst, Alex Kamphuis, Cees Trouwborst, 2016 licensed under the MIT License

core.cli.dependencies.check_installed_packages()

Checks for every module that is available, if the ROS packages needed for it are installed on the system

Returns:Boolean

core.cli.dependencies.get_aptget_packages(ros_package_names)

Returns installation candidates in a list [[ros_package_name, aptget_package], ...] This is based on the package names provided as the parameter

Parameters:ros_package_names – Returns:

core.cli.dependencies.get_distinct_packages(modules)

core.cli.dependencies.get_installed_packages()

Gets the currently installed ROS packages and returns the names as an array :return:

core.cli.dependencies.get_missing_packages(viki_config)

Looks for missing ROS packages that are defined as dependency in a module :return: List with names of the missing ROS packages

core.cli.dependencies.get_modules(viki_config)

core.cli.dependencies.get_package_locations()

Uses ‘rosdep db’ and parsing to get the packages that we can install and the apt-get packages to install it

Returns:

core.cli.dependencies.get_second_level_dependencies()

core.cli.dependencies.install_second_level_dependencies()

core.cli.dependencies.start_aptget_installation(installation_candidates)

Installs the packages that are provided in aa package list :param installation_candidates: :return:

core.cli.dependencies.start_vcs_installation(missing_vcs_packages)

core.cli.repositories module

VIKI: more than a GUI for ROS, https://github.com/UT-RAM/viki version: 0.2 - Alice copyright: Robin Hoogervorst, Alex Kamphuis, Cees Trouwborst, 2016 licensed under the MIT License

core.cli.repositories.catkin_make()

core.cli.repositories.clone_module_repository(repo, viki_config)

Clone a repository into the viki_modules folder :param repo: :return:

core.cli.runnables module

VIKI: more than a GUI for ROS, https://github.com/UT-RAM/viki version: 0.2 - Alice copyright: Robin Hoogervorst, Alex Kamphuis, Cees Trouwborst, 2016 licensed under the MIT License

core.cli.runnables.add_module_repository(options)

core.cli.runnables.check_packages(options)

Checks if all packages that should be installed are installed First-level: ROS packages that are required for VIKI directly Second-level: Dependencies of ROS-packages :return:

core.cli.runnables.configure(options)

Usually the first command to run. This will install apt-get dependencies to run VIKI properly, and do some more configuration like creating a desktop entry

Returns:

core.cli.runnables.install_packages(options)

Installs packages that the ‘check_packages’ function determines as missing This can either be with apt-get, or git, something else is not yet supported :return:

core.cli.runnables.print_to_terminal(string, color='black')

core.cli.runnables.process_template(file, viki_config)

core.cli.runnables.run(options)

Run VIKI :D :return:

core.cli.viki_config module

VIKI: more than a GUI for ROS, https://github.com/UT-RAM/viki version: 0.2 - Alice copyright: Robin Hoogervorst, Alex Kamphuis, Cees Trouwborst, 2016 licensed under the MIT License

class core.cli.viki_config.VikiConfig

config_filename = 'config.json'

get_option(option, none_valid=False)

get_root_module_dir()

load_config()

save_config()

set_option(option, value)

Module contents

VIKI: more than a GUI for ROS, https://github.com/UT-RAM/viki version: 0.2 - Alice copyright: Robin Hoogervorst, Alex Kamphuis, Cees Trouwborst, 2016 licensed under the MIT License