catkin_pip

| Provides catkin extension (cmake hooks) to work with pure python packages in catkin workspaces. | Because state of the art python (ref. http://jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/) should be allowed to work with catkin.

catkin_pip allows you to use your own package as a normal python package, with python workflow (example using virtualenvwrapper):

$ mkvirtualenv my_package_venv --system-site-packages
(my_package_venv)$ pip install -r requirements.txt
(my_package_venv)$ python -m my_package
(my_package_venv)$ nosetests my_package
(my_package_venv)$ deactivate
$

OR using the python workflow from inside a catkin workspace:

$ source /opt/ros/indigo/setup.bash
$ cd existing_catkin_ws
$ catkin_make
$ source devel/setup.bash
$ python -m my_package
$ nosetests my_package

TODO : improve this with real simple command line examples, copied verbatim.

| It basically make use, through cmake, of the workspace as a virtual env would be used in a python flow. | Mostly it’s just a few arguments added to pip to get it to install packages in the correct way in a workspace.

The provided cmake macros are:

• catkin_pip_setup()
• catkin_pip_requirements(requirements_file)
• catkin_pip_package()

they can be used like this :

...
cmake_minimum_required(VERSION 2.8.3)
project(my_project)

find_package(catkin REQUIRED COMPONENTS
    catkin_pip
)

# Getting pip requirements for catkin_pip itself
catkin_pip_setup()

# We need to install the project pip dependencies in the devel workspace being created
catkin_pip_requirements(${CMAKE_CURRENT_SOURCE_DIR}/requirements.txt)

# defining current package as a package that should be managed by pip (not catkin - even though we make it usable with workspaces)
catkin_pip_package()

# Corresponding install rules are also setup by each of these macros.
...

As a result you can:

• Use pip/setup.py dependency mechanism with any python git repo, for devel workspace.
• Use pip dependency requirements mechanism with any pip dependency, for devel workspace.
• Directly work with python package sources in your usual catkin workspaces (devel only), after just adding a [CMakeLists.txt]{.title-ref} and a [package.xml]{.title-ref} files.
• Work with "hybrid" packages that can be released both via pip packages and ros packages, provided the proper dependencies exists for both package management systems (Note rosdep support of pip is not clear...).
• Do a Third Party release of an existing python package into a ROS package (no setup.py changes required).

Changelog for package catkin_pip

0.2.0 (2017-03-17)

• removing dependency on daemontools (not available on fedora)
• setlock -> flock
• Merge pull request #95 from k-okada/install_data data should not install right under the CMAKE_INSTALL_PREFIX
• fixing syntax for ros distro autodetection when building this package.
• Merge pull request #97 from asmodehn/gopher-devel Preparing next release 0.2
• install data
• Contributors: AlexV, Kei Okada, alexv
• Merge branch 'devel' into gopher-devel
• now using catkin_pip_runcmd to retrieve cookiecutter package samples.
• removing install envhook. seems to break things. we dont want the install envhook to be created for catkin_pip since the target build env does not exist.
• Merge pull request #61 from asmodehn/refactor_envs Refactor envs
• adding docs to make decision clear regarding catkin / pyros_setup behavior.
• fixing up install devel command since we do not pass editable pkg path into pythonpath anymore.
• Merge branch 'gopher-devel' into refactor_envs
• Merge pull request #76 from asmodehn/easyinstall_fix Easyinstall fix
• commenting install tests... we dont have any.
• always adding the catkin_pip_env path to pythonpath to be able to find basic tools from the first time around.
• envhooks now not adding to pythonpath from pth files. too confusing. envhooks now not adding non existent paths to pythonpath. maybe good idea to match site module behavior. fixing tests.
• improved tests. added test for check with pyros_setup and interractive debugging
• fixed broken tests. now needs pyros-setup to get .pth paths before workspaces. cosmetics.
• improved tests and fix all. added actual test for pytest to pipproject.
• cleaning up command args when running pip install --editable to clean python path and workaround pip bug...
• replacing CI_ROS_DISTRO var by ROS_DISTRO, to have it set for calls to rosdep.
• more exhaustive test for sys_path
• commenting echoes from script since it cannot echo without breaking things anyway.
• reviewing shell script to make them a tiny more robust...
• removed useless bash envhook, fixed easy-install parse to include last line even if no empty line at end of file.
• Merge pull request #77 from asmodehn/pyup-update-pytest-3.0.5-to-3.0.6 Update pytest to 3.0.6
• Merge pull request #86 from asmodehn/pyup-update-cookiecutter-1.5.0-to-1.5.1 Update cookiecutter to 1.5.1
• Update cookiecutter from 1.5.0 to 1.5.1
• moved rosdep install out of catkin_pip, only used for tests. temporarily skipping broken test because of pip behavior...
• improved concurrency handling for pip by using setlock from daemontools. improved status message output.
• adding libssl-dev as dependency forpypackage
• adding catkin_pip function to call rosdep install. attempting fix for pypackage tests.
• adding libffi-dev as build_depend for python_boilerplate
• API changed ! redesigned workflow by doing "pip install -e package" during make stage instead of configure. All tests passing.
• Update pytest from 3.0.5 to 3.0.6
• reverted to pip 8.1.2 changes added in prevision of switching to pip 9.X when --ignore-installed working...
• added comment about sourcing install/setup.bash
• improved test cases to check the content of easy-install.pth
• adding cookiecutter pypackage-minimal for tests
• adding cookiecutter pypackage for tests
• adding cookiecutter pylibrary for testing
• adding result of investigation for unexpected dist-packages in sys.path tail... still WIP
• now handling environment setup only via catkin_env from env-hooks. made pure sh envhook to allow implementing other shells.
• WIP refactoring how we setup configure / build / devel/ install enironments
• improved path_prepend shell script
• Contributors: AlexV, alexv, pyup-bot
• removing install envhook. seems to break things. we dont want the install envhook to be created for catkin_pip since the target build env does not exist.
• Merge pull request #61 from asmodehn/refactor_envs Refactor envs
• adding docs to make decision clear regarding catkin / pyros_setup behavior.
• fixing up install devel command since we do not pass editable pkg path into pythonpath anymore.

File truncated at 100 lines see the full file