ament_cmake_python

This package adds functions for installing Python packages and modules in CMake.

API

Calling find_package(ament_cmake_python) will make the following API available.

ament_get_python_install_dir

The CMake function ament_get_python_install_dir gets the path Python packages will be installed to. The path is always relative to CMAKE_INSTALL_PREFIX.

The path can be customized by setting PYTHON_INSTALL_DIR on the command line. It must be a relative path. For example, the cmake command bellow would cause Python code to be installed to ${CMAKE_INSTALL_PREFIX}/foobar/site-packages.

$ cmake ../path/to/package/using/ament_cmake_python -DPYTHON_INSTALL_DIR=foobar/site-packages

ament_python_install_module

The CMake macro ament_python_install_module will install a single Python module to the Python install directory.

ament_python_install_package

The CMake macro ament_python_install_package will install a Python package and all subpackages to the Python install directory.

Changelog for package ament_cmake_python

2.7.1 (2024-10-03)

2.7.0 (2024-06-25)

2.6.1 (2024-06-17)

2.6.0 (2024-04-26)

2.5.0 (2024-04-16)

2.4.0 (2024-03-28)

• Add in a comment explaining where Python3::Interpreter comes from. (#510)
• Update maintainer list in package.xml files (#503)
• Contributors: Chris Lalancette, Michael Jeronimo

2.3.2 (2023-12-26)

2.3.1 (2023-11-06)

2.3.0 (2023-09-07)

2.2.2 (2023-08-21)

2.2.1 (2023-06-21)

2.2.0 (2023-06-07)

2.1.0 (2023-04-26)

2.0.2 (2023-04-12)

2.0.1 (2023-04-11)

2.0.0 (2023-04-11)

• Support Debian-specific install dir for ament_cmake_python (#431)
• Contributors: Timo Röhling

1.5.3 (2023-02-13)

• [rolling] Update maintainers - 2022-11-07 (#411)
  • Update maintainers to Michael Jeronimo
• Contributors: Audrow Nash

1.5.2 (2022-11-02)

1.5.1 (2022-09-13)

1.5.0 (2022-07-11)

• Document ament_cmake_python (#387)
• Contributors: Shane Loretz

1.4.0 (2022-04-29)

1.3.1 (2022-03-28)

• Use sysconfig directly to determine python lib dir (#378)
• Contributors: Scott K Logan

1.3.0 (2022-02-17)

• Update forthcoming version in changelog
• Contributors: Audrow Nash

1.2.1 (2022-01-14)

• Resolve various ament_lint linter violations (#360) We can't add ament_lint linters in ament_cmake in the traditional way without creating a circular dependency between the repositories. Even though we can't automatically enforce linting, it's still a good idea to try to keep conformance where possible.
• Update maintainers to Michael Jeronimo and Michel Hidalgo (#362)
• Contributors: Audrow Nash, Scott K Logan

1.2.0 (2021-10-29)

• Make ament_cmake_python symlink for symlink installs only (#357)
• Use FindPython3 instead of FindPythonInterp (#355)
• Make ament_python_install_package() match setuptools' egg names. (#338)
• Drop ament_cmake_python outdated tests. (#340)
• Update maintainers (#336)
• Make ament_python_install_package() install console_scripts (#328)
• Contributors: Chris Lalancette, Michel Hidalgo, Shane Loretz

1.1.4 (2021-05-06)

1.1.3 (2021-03-09)

• Symlink setup.cfg and sources before building Python egg-info (#327)
• Simplify ament_python_install_package() macro. (#326) Do not delegate to setuptools, install egg-info manually.
• Contributors: Michel Hidalgo

1.1.2 (2021-02-26 22:59)

• Escape $ENV{DESTDIR} everywhere in ament_python_install_package() (#324) Follow up after f80071e2216e766f7bf1b0792493a5f6523e9226
• Contributors: Michel Hidalgo

1.1.1 (2021-02-26 19:12)

• Use DESTDIR on ament_python_install_package() (#323)
  • Use DESTDIR on ament_python_install_package()
• Contributors: Michel Hidalgo

1.1.0 (2021-02-24)

• Make ament_python_install_package() install a flat Python egg (#316)
• Contributors: Michel Hidalgo

1.0.4 (2021-01-25)

1.0.3 (2020-12-10)

• [ament_cmake_python] ament_cmake_python_get_python_install_dir public (#300)
  • [ament_cmake_python] make the ament_cmake_python_get_python_install_dir a public interface.
• Contributors: Naveau

1.0.2 (2020-12-07)

• Update package maintainers. (#286)
• Contributors: Michel Hidalgo

1.0.1 (2020-09-10)

1.0.0 (2020-07-22)

0.9.6 (2020-06-23)

0.9.5 (2020-06-02)

0.9.4 (2020-05-26)

0.9.3 (2020-05-19)

0.9.2 (2020-05-07)

0.9.1 (2020-04-24 15:45)

0.9.0 (2020-04-24 12:25)

0.8.1 (2019-10-23)

0.8.0 (2019-10-04)

• ensure that PYTHON_INSTALL_DIR is initialized for generated .dsv file (#190)
  • ensure that PYTHON_INSTALL_DIR is initialized for generated .dsv file
  • use native path of PYTHON_INSTALL_DIR
• Contributors: Dirk Thomas

0.7.3 (2019-05-29)

0.7.2 (2019-05-20)

0.7.1 (2019-05-07)

0.7.0 (2019-04-08)

0.6.0 (2018-11-13)

0.5.1 (2018-07-17)

0.5.0 (2018-06-13)

0.4.0 (2017-12-08)

• install file and not absolute path (#110)
• 0.0.3
• Merge pull request #103 from ament/resolve_some_todos Resolve some todos
• compile installed Python modules and packages by default, add option to skip compilation
• 0.0.2
• Merge pull request #84 from ament/use_in_list use IN_LIST
• use IN_LIST
• update schema url
• add schema to manifest files
• Merge pull request #72 from ament/cmake35 require CMake 3.5
• require CMake 3.5
• Merge pull request #58 from ament/destination_suffix change DESTINATION argument name of ament_python_install_module()
• change DESTINATION argument name of ament_python_install_module()
• Merge pull request #57 from ament/only-install-python Added DESTINATION argument
• Added DESTINATION argument
• Merge pull request #40 from ament/consistent_path_sep use consistent path separator
• use platform specific path separators
• add explicit build type
• label todo with author
• disable debug output
• add missing copyright / license information, update format of existing license information
• Merge pull request #3 from ament/windows Windows Support
• addressing review comments
• [windows] convert in paths to / for CMake Otherwise CMake will interpret them as escape sequences or as line continuations.
• exclude .pyc files and __pycache_ folders from installation
• update cmake code style only
• fix Python install dir
• use project(.. NONE)
• refactor several low-level packages into ament_cmake_core (environment, environment_hooks, index, package_templates, symlink_install)
• invert dependency between ament_cmake_environment and ament_cmake_environment_hooks, add dependency on ament_cmake_environment
• refactor to use templates provided by ament_package
• refactored PYTHON_INSTALL_DIR computation
• update cmake code style
• minor fixes
• add ament_cmake_environment_hooks
• minor
• add ament_cmake_python
• Contributors: Dirk Thomas, Esteve Fernandez, Mikael Arguedas, William Woodall