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

1.3.11 (2024-11-25)

1.3.10 (2024-07-26)

1.3.9 (2024-05-15)

1.3.8 (2024-02-16)

1.3.7 (2024-01-24)

1.3.6 (2023-11-13)

1.3.5 (2023-06-22)

1.3.4 (2023-04-25)

1.3.3 (2022-11-07)

1.3.2 (2022-05-17)

• Document ament_cmake_python (#387) (#388)
• Contributors: mergify[bot]

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)

File truncated at 100 lines see the full file