robot-folders 0.4.1__tar.gz

robot_folders-0.4.1/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.1
+Name: robot_folders
+Version: 0.4.1
+Summary: robot_folders is your workspace handling utility around the ROS ecosystem.
+Requires-Python: >=3
+Description-Content-Type: text/x-rst
+Requires-Dist: Click>=8.0
+Requires-Dist: gitpython
+Requires-Dist: inquirer
+Requires-Dist: PyYaml
+Requires-Dist: vcstool
+
+Robot Folders
+=============
+
+Welcome to ``robot_folders``! ``robot_folders`` is a collection of utility scripts designed to
+streamline and facilitate the management of workspaces used for (ROS) development. It is designed
+to enhance efficiency in handling different environments, consisting of multiple workspaces like a
+``catkin_workspace`` and ``colcon_workspace`` or a plain CMake workspace.
+
+It focuses on optimizing the management of various subworkspaces, contributing
+to a seamless development experience.
+
+
+Quick start
+------------
+
+It is recommended to install robot_folders using ``pipx`` (You can install ``pipx`` using ``sudo apt
+install pipx``). Please note: With pipx versions < 1.0 you'll have to provide the `--spec` flag
+
+.. code:: bash
+
+   # pipx >= 1.0 (from ubuntu 22.04 on)
+   pipx install git+https://github.com/fzi-forschungszentrum-informatik/robot_folders.git
+   # pipx < 1.0 (ubuntu 20.04)
+   pipx install --spec git+https://github.com/fzi-forschungszentrum-informatik/robot_folders.git robot-folders
+
+Upgrade
+-------
+
+To upgrade robot_folders using ``pipx`` do
+
+.. code:: bash
+
+   # pipx >= 1.0 (from ubuntu 22.04 on)
+   pipx upgrade robot-folders
+   # pipx < 1.0 (ubuntu 20.04)
+   pipx upgrade --spec git+https://github.com/fzi-forschungszentrum-informatik/robot_folders.git robot-folders
+
+Shell setup
+-----------
+
+In order to use ``robot_folders`` you'll have to call its source file. How to do this depends on
+the way you installed ``robot_folders`` and on the version of the installation tool.
+
+In case you have installed
+``robot_folders`` using ``pipx`` as described above (and given you use the bash shell), do:
+
+.. code:: bash
+
+   # pipx < 1.3.0 or if ${HOME}/.local/pipx already existed
+   echo "source ${HOME}/.local/pipx/venvs/robot-folders/bin/rob_folders_source.sh" >> ~/.bashrc
+   # pipx >= 1.3.0
+   echo "source ${HOME}/.local/share/pipx/venvs/robot-folders/bin/rob_folders_source.sh" >> ~/.bashrc
+
+In case you manually installed ``robot_folders`` using a python virtualenv the path is similarly
+
+.. code:: bash
+
+   echo "source <your-vurtualenv-path>/bin/rob_folders_source.sh" >> ~/.bashrc
+
+
+Basic usage
+-----------
+
+After installation open up a new terminal to use robot_folders. The main
+command for using robot_folders is ``fzirob``. Type
+
+.. code:: bash
+
+   fzirob --help
+
+to get an overview over all available commands.

robot_folders-0.4.1/README.rst

@@ -0,0 +1,71 @@
+Robot Folders
+=============
+
+Welcome to ``robot_folders``! ``robot_folders`` is a collection of utility scripts designed to
+streamline and facilitate the management of workspaces used for (ROS) development. It is designed
+to enhance efficiency in handling different environments, consisting of multiple workspaces like a
+``catkin_workspace`` and ``colcon_workspace`` or a plain CMake workspace.
+
+It focuses on optimizing the management of various subworkspaces, contributing
+to a seamless development experience.
+
+
+Quick start
+------------
+
+It is recommended to install robot_folders using ``pipx`` (You can install ``pipx`` using ``sudo apt
+install pipx``). Please note: With pipx versions < 1.0 you'll have to provide the `--spec` flag
+
+.. code:: bash
+
+   # pipx >= 1.0 (from ubuntu 22.04 on)
+   pipx install git+https://github.com/fzi-forschungszentrum-informatik/robot_folders.git
+   # pipx < 1.0 (ubuntu 20.04)
+   pipx install --spec git+https://github.com/fzi-forschungszentrum-informatik/robot_folders.git robot-folders
+
+Upgrade
+-------
+
+To upgrade robot_folders using ``pipx`` do
+
+.. code:: bash
+
+   # pipx >= 1.0 (from ubuntu 22.04 on)
+   pipx upgrade robot-folders
+   # pipx < 1.0 (ubuntu 20.04)
+   pipx upgrade --spec git+https://github.com/fzi-forschungszentrum-informatik/robot_folders.git robot-folders
+
+Shell setup
+-----------
+
+In order to use ``robot_folders`` you'll have to call its source file. How to do this depends on
+the way you installed ``robot_folders`` and on the version of the installation tool.
+
+In case you have installed
+``robot_folders`` using ``pipx`` as described above (and given you use the bash shell), do:
+
+.. code:: bash
+
+   # pipx < 1.3.0 or if ${HOME}/.local/pipx already existed
+   echo "source ${HOME}/.local/pipx/venvs/robot-folders/bin/rob_folders_source.sh" >> ~/.bashrc
+   # pipx >= 1.3.0
+   echo "source ${HOME}/.local/share/pipx/venvs/robot-folders/bin/rob_folders_source.sh" >> ~/.bashrc
+
+In case you manually installed ``robot_folders`` using a python virtualenv the path is similarly
+
+.. code:: bash
+
+   echo "source <your-vurtualenv-path>/bin/rob_folders_source.sh" >> ~/.bashrc
+
+
+Basic usage
+-----------
+
+After installation open up a new terminal to use robot_folders. The main
+command for using robot_folders is ``fzirob``. Type
+
+.. code:: bash
+
+   fzirob --help
+
+to get an overview over all available commands.

robot_folders-0.4.1/bin/rob_folders-complete.sh

@@ -0,0 +1,53 @@
+##
+## Copyright (c) 2024 FZI Forschungszentrum Informatik
+##
+## Permission is hereby granted, free of charge, to any person obtaining a copy
+## of this software and associated documentation files (the "Software"), to deal
+## in the Software without restriction, including without limitation the rights
+## to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+## copies of the Software, and to permit persons to whom the Software is
+## furnished to do so, subject to the following conditions:
+##
+## The above copyright notice and this permission notice shall be included in
+## all copies or substantial portions of the Software.
+##
+## THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+## IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+## FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+## THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+## LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+## OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+## THE SOFTWARE.
+##
+
+if [ -n "${ZSH_VERSION+1}" ];
+then
+  compdef _rob_folders_completion fzirob
+fi
+if [ -n "${BASH_VERSION+1}" ];
+then
+  _fzirob_completion() {
+    # replace 'fzirob' with 'rob_folders' for completion
+    _rob_folders_completion rob_folders ${@:2}
+    return 0
+  }
+  complete -F _fzirob_completion -o default fzirob
+fi
+#complete -F _rob_folders_completion -o default rob_folders;
+
+# ce completion in zsh works through the alias definition. For bash we have to declare it.
+if [ -n "${BASH_VERSION+1}" ];
+then
+  _ce_completion() {
+    checkout_dir=$(rob_folders get_checkout_base_dir)
+    #_envs=$(ls ${checkout_dir})
+    _envs=$(ce --help | sed -e '1,/Commands:/d' )
+    local cur prev
+    COMPREPLY=()
+    cur="${COMP_WORDS[COMP_CWORD]}"
+    COMPREPLY=( $(compgen -W "${_envs}" -- ${cur}) )
+    return 0
+  }
+
+  complete -F _ce_completion -o default ce;
+fi

robot_folders-0.4.1/bin/rob_folders_get_source_command.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+#
+# Copyright (c) 2024 FZI Forschungszentrum Informatik
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+"""Small hacky script to get the correct source_zsh command per click version"""
+
+import argparse
+import click
+
+
+def get_click_version():
+    click_version = click.__version__
+    click_major_version = click_version.split(".")[0]
+    return int(click_major_version)
+
+
+def print_source_command(shell: str):
+    click_version = get_click_version()
+    if click_version >= 8:
+        print(f"{shell}_source")
+    else:
+        print(f"source_{shell}")
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-s", "--shell", type=str, choices=["bash", "zsh"], default="bash"
+    )
+    args = parser.parse_args()
+    print_source_command(args.shell)
+
+
+if __name__ == "__main__":
+    main()

robot_folders-0.4.1/bin/rob_folders_source.sh

@@ -0,0 +1,199 @@
+##
+## Copyright (c) 2024 FZI Forschungszentrum Informatik
+##
+## Permission is hereby granted, free of charge, to any person obtaining a copy
+## of this software and associated documentation files (the "Software"), to deal
+## in the Software without restriction, including without limitation the rights
+## to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+## copies of the Software, and to permit persons to whom the Software is
+## furnished to do so, subject to the following conditions:
+##
+## The above copyright notice and this permission notice shall be included in
+## all copies or substantial portions of the Software.
+##
+## THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+## IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+## FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+## THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+## LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+## OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+## THE SOFTWARE.
+##
+
+# zsh
+if [ -d "$HOME/.local/bin" ] ; then
+    PATH="$HOME/.local/bin:$PATH"
+fi
+my_source="source"
+if [ -n "${ZSH_VERSION+1}" ];
+then
+  # Get the base directory where the install script is located
+  export ROB_FOLDERS_BASE_DIR="$( cd "$( dirname "${(%):-%N}" )/.." && pwd )"
+  my_source=$(rob_folders_get_source_command.py -s zsh)
+fi
+
+# bash
+if [ -n "${BASH_VERSION+1}" ];
+then
+  # Get the base directory where the install script is located
+  export ROB_FOLDERS_BASE_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd )"
+  my_source=$(rob_folders_get_source_command.py -s bash)
+fi
+eval "$(_ROB_FOLDERS_COMPLETE=${my_source} rob_folders)"
+
+# if there is alreay an active environment, refrain from scraping the empty paths
+# (they must already there)
+if [ -z "$ROB_FOLDERS_ACTIVE_ENV" ]; then
+  export ROB_FOLDERS_EMPTY_CMAKE_PATH=${CMAKE_PREFIX_PATH}
+  export ROB_FOLDERS_EMPTY_PATH=${PATH}
+  export ROB_FOLDERS_EMPTY_LD_LIBRARY_PATH=${LD_LIBRARY_PATH}
+  export ROB_FOLDERS_EMPTY_QML_IMPORT_PATH=${QML_IMPORT_PATH}
+  export ROB_FOLDERS_EMPTY_PYTHONPATH=${PYTHONPATH}
+
+  if [ ! -z "${ROB_FOLDERS_EMPTY_CMAKE_PATH}" ] && [ -z $ROB_FOLDERS_IGNORE_CMAKE_PREFIX_PATH ]
+  then
+    echo "WARNING! WARNING! WARNING!"
+    echo "Your CMAKE_PREFIX_PATH is not empty. This probably means that you explicitly set your
+CMAKE_PREFIX_PATH to include some custom directory. If you want to keep this that way you can
+export the environment variable ROB_FOLDERS_IGNORE_CMAKE_PREFIX_PATH to some arbitrary value to
+suppress this warning. e.g.
+
+    export ROB_FOLDERS_IGNORE_CMAKE_PREFIX_PATH=\":-)\"
+    source /home/mauch/robot_folders/bin/fzirob_source.sh
+"
+    echo "By, the way your CMAKE_PREFIX_PATH is: \"${CMAKE_PREFIX_PATH}\""
+    echo "WARNING! WARNING! WARNING! END."
+  fi
+else
+  echo "Robot folder environment active: ($ROB_FOLDERS_ACTIVE_ENV)"
+fi
+
+
+
+# define some legacy aliases from old robot_folders
+alias ce="fzirob change_environment"
+alias cdr="fzirob cd"
+alias cdros="fzirob cd ros"
+alias cdcol="fzirob cd colcon"
+alias cdhome="fzirob cd"
+alias makeros="fzirob make ros"
+alias makecol="fzirob make colcon"
+
+add_fzi_project()
+{
+  echo "DEPRECATED! DEPRECATED! DEPRECATED! DEPRECATED!"
+  echo "The use of this call is deprecated!!!"
+  echo "DEPRECATED! DEPRECATED! DEPRECATED! DEPRECATED!"
+  echo "Please use the command 'fzirob add_environment' in future"
+  echo "DEPRECATED! DEPRECATED! DEPRECATED! DEPRECATED!"
+  echo "Executing 'fzirob add_environment' now"
+  fzirob add_environment $@
+}
+
+# These aliases are created after an environment is changed into.
+# They are environment-specific but are created for all environments.
+# Note: This is not done in the source_environment.sh script as the source
+# script might be overwritten by the user and then suddenly these aliases
+# won't be there anymore. We decided to keep all alias definitions inside
+# this file.
+env_aliases()
+{
+  alias kdevsession="kdevelop -s ${ROB_FOLDERS_ACTIVE_ENV}"
+}
+
+
+check_env()
+{
+  # for relevant env_vars
+  #   for each entry
+  #     if ROB_FOLDERS_CHECKOUT_DIR in entry and ROB_FOLDERS_ACTIVE_END not in entry
+  #       cry
+  VAR=$(echo "${CMAKE_PREFIX_PATH}" | sed 's/:/ /g')
+  checkout_dir=$(rob_folders get_checkout_base_dir)
+  for entry in $(echo "${VAR}"); do
+    if [[ "${entry}" =~ ${checkout_dir} ]]; then
+      if [[ ! "${entry}" =~ ${checkout_dir}/${ROB_FOLDERS_ACTIVE_ENV} ]]; then
+        echo "\033[0;33mWARNING: CMAKE_PREFIX_PATH contains a path outside the current env: ${entry}\033[0m"
+        echo "You probably built your catkin_ws the first time, when another workspace was sourced. To solve this, go to your catkin_ws, delete build and devel, open a new shell, source your environment, build your catkin_ws."
+      fi
+    fi
+  done
+}
+
+reset_environment()
+{
+  export CMAKE_PREFIX_PATH=${ROB_FOLDERS_EMPTY_CMAKE_PATH}
+  export PATH=${ROB_FOLDERS_EMPTY_PATH}
+  export LD_LIBRARY_PATH=${ROB_FOLDERS_EMPTY_LD_LIBRARY_PATH}
+  export QML_IMPORT_PATH=${ROB_FOLDERS_EMPTY_QML_IMPORT_PATH}
+  export PYTHONPATH=${ROB_FOLDERS_EMPTY_PYTHONPATH}
+}
+
+
+# Create the fzirob function
+#
+# Since rob_folders is a python program, it cannot execute commands
+# directly on the shell such as 'cd' or setting environment variables.
+# For this reason we created this wrapper function that performs
+# the shell actions.
+fzirob()
+{
+  if [ $# -ge 1 ]; then
+    # if we want to cd to a directory, we need to capture the output
+    if [ $1 = "cd" ]; then
+      output=$(rob_folders $@)
+      echo "$output"
+      cd_target=$(echo "$output" | grep "^cd" | tail -n 1 | sed s/cd\ //)
+      if [ ! -z "${cd_target// }" ]; then
+        cd ${cd_target}
+      fi
+    else
+      if [ $1 = "add_environment" ] && [ "$2" != "--help" ]; then
+        echo "Resetting environment before adding new one."
+        reset_environment
+      fi
+
+      echo "rob_folders $@"
+
+      rob_folders $@
+
+      if [ $? -eq 0 ]; then
+        if [ $1 = "change_environment" ] && [ "$2" != "--help"  ]; then
+          checkout_dir=$(rob_folders get_checkout_base_dir)
+          if [ -f ${checkout_dir}/.cur_env ]; then
+            export ROB_FOLDERS_ACTIVE_ENV=$(cat ${checkout_dir}/.cur_env)
+            environment_dir="${checkout_dir}/${ROB_FOLDERS_ACTIVE_ENV}"
+            if [ -f ${environment_dir}/setup.sh ]; then
+              source ${environment_dir}/setup.sh
+            elif [ -f ${environment_dir}/setup.zsh ]; then
+              source ${environment_dir}/setup.zsh
+            elif [ -f ${environment_dir}/setup.bash ]; then
+              source ${environment_dir}/setup.bash
+            else
+              source ${ROB_FOLDERS_BASE_DIR}/bin/source_environment.sh
+            fi
+            # declare environment-specific aliases
+            env_aliases
+            #check_env
+          else
+            echo "Could not change environment"
+          fi
+        elif [ $1 = "add_environment" ] && [ "$2" != "--help"  ]; then
+          if [ -z "$ROB_FOLDERS_ACTIVE_ENV" ]; then
+            fzirob change_environment
+            echo "Sourced new environment"
+          else
+            echo "Currently, there is a sourced environment ($ROB_FOLDERS_ACTIVE_ENV). Not sourcing new one."
+          fi
+        fi
+      else
+        return $?
+      fi
+    fi
+  else
+    rob_folders --help
+  fi
+}
+
+# sourcing alias
+source ${ROB_FOLDERS_BASE_DIR}/bin/rob_folders-complete.sh