ament_index_python

ament_index_python is a python API to access the ament resource index.

See https://github.com/ament/ament_cmake/blob/master/ament_cmake_core/doc/resource_index.md for documentation on the ament resource index.

Quality Declaration

See the Quality Declaration for details on the declared Quality Level.

Changelog for package ament_index_python

1.12.0 (2025-04-24)

1.11.0 (2025-04-24)

1.10.2 (2025-04-17)

• Add py.typed to package_data (#100)
• Contributors: Michael Carlstrom

1.10.1 (2024-11-20)

• Add test_xmllint to ament_index_python. (#96)
• Contributors: Chris Lalancette

1.10.0 (2024-10-03)

• Add ament_mypy unit test and export types (#95)
• Contributors: Michael Carlstrom

1.9.0 (2024-04-26)

• Update quality declaration documents (#94)
• Contributors: Christophe Bedard

1.8.0 (2024-03-28)

• Add type annotations to python files. (#93)
• Contributors: Michael Carlstrom

1.7.0 (2023-08-21)

1.6.0 (2023-04-27)

1.5.2 (2023-02-14)

• [rolling] Update maintainers - 2022-11-07 (#89)
• Contributors: Audrow Nash

1.5.1 (2022-09-13)

1.5.0 (2022-04-29)

1.4.0 (2022-03-01)

• Print warning when get_package_share_directory() does not exist (Fix #74) (#77)
• Fail lookups on invalid resource names (#69)
• Add get_package_share_path method (#73)
• Contributors: David V. Lu, rob-clarke

1.0.6 (2021-05-06)

1.0.5 (2021-04-14)

• Remove Claire as the maintainer. (#71)
• Contributors: Chris Lalancette

1.0.4 (2021-04-06)

• Change links from index.ros.org -> docs.ros.org (#70)
• Contributors: Chris Lalancette

1.0.3 (2021-03-18)

• Add Audrow as a maintainer (#68)
• Contributors: Audrow Nash

1.0.2 (2021-01-25)

• update maintainers (#67)
• Contributors: Claire Wang

1.0.1 (2020-10-07)

• add rational why ament_index pkgs don't have explicit performance tests (#65)
• Remove the Quality Level from the README.md. (#62)
• Fix document link (#61)
• [Quality Declaration] Update Version Stability to stable version (#58)
• Contributors: Alejandro Hernández Cordero, Chris Lalancette, Dirk Thomas, Matthijs van der Burgh

1.0.0 (2020-05-22)

• Added Doxygen and Sphinx (#55)
• Fixes Quality Declaration link + style (#54)
• Add quality declaration ament_index_python (#50)
• Contributors: Alejandro Hernández Cordero, Jorge Perez

0.8.0 (2020-04-17)

• more verbose test_flake8 error messages (same as ros2/launch_ros#135)
• Add copyright checker for ament_index_python files (#44)
• Code refactors to the ament_index_python test (#43)
• Increase test coverage ament_index_python (#41)
• Fix resource name autocompleter in ament_index CLI (#42)
• Contributors: Dirk Thomas, Jorge Perez

0.7.2 (2019-10-16)

• 0.7.2
• fix completion of first arg (#38)
• install resource marker file for package (#37)
• add ament_index CLI (#35)
• Contributors: Dirk Thomas

0.7.1 (2019-09-18)

• install package manifest (#34)
• Contributors: Dirk Thomas

0.7.0 (2019-04-11)

0.5.1 (2018-06-18 13:50)

• level setup.py versions to 0.5.1
• Contributors: Mikael Arguedas

0.5.0 (2018-06-18 13:25)

• add pytest markers to linter tests
• set zip_safe to avoid warning during installation (#29)
• Contributors: Dirk Thomas

0.4.0 (2017-12-08)

• remove test_suite, add pytest as test_requires
• 0.0.3
• update style to satisfy new flake8 plugins
• 0.0.2
• use flake8 instead of pep8 and pyflakes
• refactor get_package_prefix to be more efficient
• add function to get packages with prefixes as dict
• doc fixup
• test package related functions
• add package related functions
• refactor ament_index_python into separate files
• expose prefix path from get_resource, add C++ has_resource
• update schema url
• add schema to manifest files
• Check resource file is readable
• Ignore subdirectories and dotfiles in get_resources
• Ignore dot files in get_resources
• update unit tests to match #10
• fix finding resources in overlayed workspaces
• add pep257 check
• add tests for ament_index_python, fix behavior
• add Python API to read information from the ament index
• Contributors: Deanna Hood, Dirk Thomas, Tully Foote, William Woodall, dhood