rospkg documentation

The rospkg module provides basic utilities for querying information about ROS packages and stacks. There are several basic APIs: ROS environment, RosPack/RosStack, and OS detection. The environment APIs enable access to environment settings that defines the ROS package/stack filesystem configuration. The RosPack and RosStack APIs are similar to the rospack and rosstack command-line tools and provide information about dependency, location, and other package/stack metadata. The Manifest class provides access to a specific package/stack’s manifest information.

Example:

import rospkg

ros_root = rospkg.get_ros_root()

r = rospkg.RosPack()
depends = r.get_depends('roscpp')
path = r.get_path('rospy')

Common API

exception rospkg.ResourceNotFound

Requested resource (e.g. package/stack) could not be found.

Installation

rospkg is available on pypi and can be installed via pip

pip install rospkg

or easy_install:

easy_install rospkg

Using rospkg

The rospkg module is meant to be used as a normal Python module. After it has been installed, you can import it normally and do not need to declare as a ROS package dependency.

Indices and tables

Project Versions

Table Of Contents

Next topic

ROS package access

This Page