ROSA - ROS Accessories

Commands for quickly performing common operations in ROS.

Installation

To install, run the following:

pip install rosa

Or, if you wish to install the latest from source:

git clone https://github.com/abencz/rosa
cd rosa
python setup.py install

Usage & Examples

ROSA installs a new command (rosa) which includes subcommands for doing common ROS tasks. And, of course, there's a --help:

rosa --help

Creating a Workspace

To create a workspace, source your setup.{bash,zsh,sh} of choice from either opt/ros or from an existing workspace if using overlays, then run rosa:

source /opt/ros/hydro/setup.bash
rosa create_workspace my_workspace

If you have a rosintall you're going to use with this workspace, you can add it up immidiately using the -i flag. The rosinstall will be merged in to the workspace (as if using wstool merge), and updated (wstool update):

rosa create_workspace -i ~/my.rosinstall my_workspace

As with wstool you can also use web URIs directly:

rosa create_workspace -i http://bit.ly/1xpc6AK my_workspace

Specify multiple rosinstall files using multiple -i flags:

rosa create_workspace -i ~/my.rosinstall -i http://bit.ly/1xpc6AK my_workspace

Adding ROSinstall Files to an Existing Workspace

You can also merge rosinstall files into a workspace that already exists. From anywhere in the target workspace:

rosa merge_rosinstall ~/my.rosinstall

Once again, URIs are fair game as are multiple rosinstall files:

rosa merge_rosinstall ~/my.rosinstall http://bit.ly/1xpc6AK

If you're not inside a workspace or you want to merge the rosinstalls into a different workspace you can specify one using the -w flag:

rosa -w ~/my_workspace merge_rosinstall ~/my.rosinstall

Creating a ROSinstall File From an Existing Workspace

If you've been doing dev work in your workspace, often the rosinstall is out of sync with the packages. Using rosa you can create a rosinstall file from the current state of your workspace. If you're currently in a workspace folder, rosa will look through packages in src and compile a rosinstall that reflects the currently checked out branches, tags and commits.:

rosa generate_rosinstall

You can also specify a workspace manually:

rosa -w ~/my_workspace generate_rosinstall

If you want rosa to write the rosinstall to a file instead of stdout you can provide one to the -o flag:

rosa generate_rosinstall -o my_workspace.rosinstall

Be aware that currently this command only works with Git repositories and requires an "origin" remote to be set in order to get a valid URI for the package.

License

BSD