# cargo-ament-build
This cargo plugin is a wrapper around `cargo build` which installs build artifacts in a layout expected by ament and ROS 2 tools.
It can be used standalone or through `colcon-ros-cargo`. Its command line interface is `cargo ament-build --install-base <install base> -- <cargo build args>`.
What does this plugin do?
- It builds or checks the package, depending on whether it contains any binaries
- It copies the source code and binaries to appropriate locations in the install base
- It places marker files in the ament index
It is possible to specify additional files or directories to be installed in the `metadata` section of `Cargo.toml` like this:
```
[package.metadata.ros]
install_to_share = ["launch", "config"]
```
These paths are relative to the directory containing the `Cargo.toml` file and will be copied to the appropriate location in `share`.
The same mechanism applies with `install_to_include` and `install_to_lib`.
Target types other than libraries and binaries (i.e. benches, tests) are not yet installed.
Raw data
{
"_id": null,
"home_page": null,
"name": "cargo-ament-build",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ros2, colcon, ament",
"author": "Nikolai Morin <nnmmgit@gmail.com>",
"author_email": "Nikolai Morin <nnmmgit@gmail.com>",
"download_url": null,
"platform": null,
"description": "# cargo-ament-build\n\nThis cargo plugin is a wrapper around `cargo build` which installs build artifacts in a layout expected by ament and ROS 2 tools.\n\nIt can be used standalone or through `colcon-ros-cargo`. Its command line interface is `cargo ament-build --install-base <install base> -- <cargo build args>`.\n\nWhat does this plugin do?\n- It builds or checks the package, depending on whether it contains any binaries\n- It copies the source code and binaries to appropriate locations in the install base\n- It places marker files in the ament index\n\nIt is possible to specify additional files or directories to be installed in the `metadata` section of `Cargo.toml` like this:\n```\n[package.metadata.ros]\ninstall_to_share = [\"launch\", \"config\"]\n```\nThese paths are relative to the directory containing the `Cargo.toml` file and will be copied to the appropriate location in `share`.\n\nThe same mechanism applies with `install_to_include` and `install_to_lib`.\n\nTarget types other than libraries and binaries (i.e. benches, tests) are not yet installed.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Cargo plugin for use with colcon workspaces",
"version": "0.1.9",
"project_urls": {
"Source Code": "https://github.com/ros2-rust/cargo-ament-build"
},
"split_keywords": [
"ros2",
" colcon",
" ament"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ddc86d41c601ef40135d937bd22fdd91aa6cbd638833165fd08fed2c0942f8a1",
"md5": "ef4fd2a54f7d8984cb4ac853b2c4b9d2",
"sha256": "bf22e3b58335d0a71275b93d827eecd111e9f6dc44acbd8c7b0859244a412abe"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-macosx_10_12_x86_64.whl",
"has_sig": false,
"md5_digest": "ef4fd2a54f7d8984cb4ac853b2c4b9d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 589333,
"upload_time": "2024-10-16T09:38:40",
"upload_time_iso_8601": "2024-10-16T09:38:40.603283Z",
"url": "https://files.pythonhosted.org/packages/dd/c8/6d41c601ef40135d937bd22fdd91aa6cbd638833165fd08fed2c0942f8a1/cargo_ament_build-0.1.9-py3-none-macosx_10_12_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c671d1d677c4ba9fbc31bf7500615a6e7092e4858bd93e27d5c89745d9946bf9",
"md5": "31af44cab2d4b2c6ac6cfaacb37f0610",
"sha256": "553440cb93fca80617da84e6889834967a07a48536680d51049aafd787fe8b62"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "31af44cab2d4b2c6ac6cfaacb37f0610",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 559522,
"upload_time": "2024-10-16T09:38:39",
"upload_time_iso_8601": "2024-10-16T09:38:39.350319Z",
"url": "https://files.pythonhosted.org/packages/c6/71/d1d677c4ba9fbc31bf7500615a6e7092e4858bd93e27d5c89745d9946bf9/cargo_ament_build-0.1.9-py3-none-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "541e2d05479bf7a7b776381c4ff7a84b8a91cddb19cf6b9ce9ef16f62dbde438",
"md5": "6907c001bf127b9e2aadfbe574607c71",
"sha256": "949009749e7b77a2e362383b9dc451dec02bacd358aeafa15c8d514ccfcab14c"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "6907c001bf127b9e2aadfbe574607c71",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 613152,
"upload_time": "2024-10-16T09:38:30",
"upload_time_iso_8601": "2024-10-16T09:38:30.398344Z",
"url": "https://files.pythonhosted.org/packages/54/1e/2d05479bf7a7b776381c4ff7a84b8a91cddb19cf6b9ce9ef16f62dbde438/cargo_ament_build-0.1.9-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "046dbd8579189986cf60a7289b4aa48cffdc49e31edc06a1435ba18b197cb490",
"md5": "45516f6a14121e00f7cd1e109efede55",
"sha256": "e1daaf8cb8668b642826d4c891e94fcf31179ac2499066a71734eb6345748008"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"has_sig": false,
"md5_digest": "45516f6a14121e00f7cd1e109efede55",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 622519,
"upload_time": "2024-10-16T09:38:31",
"upload_time_iso_8601": "2024-10-16T09:38:31.835760Z",
"url": "https://files.pythonhosted.org/packages/04/6d/bd8579189986cf60a7289b4aa48cffdc49e31edc06a1435ba18b197cb490/cargo_ament_build-0.1.9-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6df4c7531fa0e06b7ef7d1a7f828f455e06dbaba2f0baf3e5e0a95f3b6e4c85d",
"md5": "fd2b4abc11e9169023d9c780ad20b9ab",
"sha256": "5bf3ad6b91b626fe2d514911e7ab71a0cb052d5d8529be476039920cc895187a"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl",
"has_sig": false,
"md5_digest": "fd2b4abc11e9169023d9c780ad20b9ab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 666653,
"upload_time": "2024-10-16T09:38:36",
"upload_time_iso_8601": "2024-10-16T09:38:36.684940Z",
"url": "https://files.pythonhosted.org/packages/6d/f4/c7531fa0e06b7ef7d1a7f828f455e06dbaba2f0baf3e5e0a95f3b6e4c85d/cargo_ament_build-0.1.9-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b36bc90c9c7bc7a2b5ddb74ea56474e82a946db96c24ffd99d167d79a44cf867",
"md5": "dde7c49aa7d78f003ae55c2433cdfbc5",
"sha256": "982e29b5e7270d9bc091a9aa7fe6dd155fc6711b9a26db1fb4dbc73e2b205c27"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl",
"has_sig": false,
"md5_digest": "dde7c49aa7d78f003ae55c2433cdfbc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 676997,
"upload_time": "2024-10-16T09:38:33",
"upload_time_iso_8601": "2024-10-16T09:38:33.451881Z",
"url": "https://files.pythonhosted.org/packages/b3/6b/c90c9c7bc7a2b5ddb74ea56474e82a946db96c24ffd99d167d79a44cf867/cargo_ament_build-0.1.9-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6ce099f8f7fecc618db56620774bef57a3c8925558ad682443a398960c3d96b7",
"md5": "9719c649c8d931665db364a7e6bafb64",
"sha256": "6e9c5830f1188fc80ed4ea7128e645d1a1b0660782d2dd95a714901209ce3a2e"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl",
"has_sig": false,
"md5_digest": "9719c649c8d931665db364a7e6bafb64",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 764249,
"upload_time": "2024-10-16T09:38:34",
"upload_time_iso_8601": "2024-10-16T09:38:34.948499Z",
"url": "https://files.pythonhosted.org/packages/6c/e0/99f8f7fecc618db56620774bef57a3c8925558ad682443a398960c3d96b7/cargo_ament_build-0.1.9-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7c0d85db5ce4d82b402ac1258696f01d85a869ff7afdef49a4a1352671905f78",
"md5": "5f38541975ef830230afc2ceace203db",
"sha256": "6d4c5790562ef421b8b8e347ff8daeabb5c1ad6733a54c9e3c17c2c130ebfd94"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "5f38541975ef830230afc2ceace203db",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 630789,
"upload_time": "2024-10-16T09:38:37",
"upload_time_iso_8601": "2024-10-16T09:38:37.895901Z",
"url": "https://files.pythonhosted.org/packages/7c/0d/85db5ce4d82b402ac1258696f01d85a869ff7afdef49a4a1352671905f78/cargo_ament_build-0.1.9-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "346c5e3ab7756f0377f8238ef13e6016fb6190beda881db4a25215fb49550b08",
"md5": "1a4a6a6bd9254c6e3276800f054bb9a7",
"sha256": "d49a5df48ee7dbcd4eea23b2cf44e95b5b7ad47d0f3db9351a06cb35d4f42444"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-musllinux_1_2_aarch64.whl",
"has_sig": false,
"md5_digest": "1a4a6a6bd9254c6e3276800f054bb9a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 656244,
"upload_time": "2024-10-16T09:38:42",
"upload_time_iso_8601": "2024-10-16T09:38:42.700988Z",
"url": "https://files.pythonhosted.org/packages/34/6c/5e3ab7756f0377f8238ef13e6016fb6190beda881db4a25215fb49550b08/cargo_ament_build-0.1.9-py3-none-musllinux_1_2_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c6a578956303c8a27610c4fbff59b81d034e0ae3ccfbe06c2ca65e5fe03722fe",
"md5": "185fea08dbe5309dc2cbb597234baa92",
"sha256": "9a21b1052699ff58b293f043127dab3fdec003f1d0426225801fbd5cf44baa4c"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-musllinux_1_2_armv7l.whl",
"has_sig": false,
"md5_digest": "185fea08dbe5309dc2cbb597234baa92",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 645633,
"upload_time": "2024-10-16T09:38:44",
"upload_time_iso_8601": "2024-10-16T09:38:44.570320Z",
"url": "https://files.pythonhosted.org/packages/c6/a5/78956303c8a27610c4fbff59b81d034e0ae3ccfbe06c2ca65e5fe03722fe/cargo_ament_build-0.1.9-py3-none-musllinux_1_2_armv7l.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ce2fb96e96ba1dedc4e466263e17bb1d442f58fede5dfe24e1bbba37a2ada9fc",
"md5": "d3d8d87e641067dee942a96ec31a006c",
"sha256": "61a8aa3e8579e36b7139b7299df7fa2a528beb9f4d293b14aed7eb9f84a1cba0"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-musllinux_1_2_i686.whl",
"has_sig": false,
"md5_digest": "d3d8d87e641067dee942a96ec31a006c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 684741,
"upload_time": "2024-10-16T09:38:46",
"upload_time_iso_8601": "2024-10-16T09:38:46.301086Z",
"url": "https://files.pythonhosted.org/packages/ce/2f/b96e96ba1dedc4e466263e17bb1d442f58fede5dfe24e1bbba37a2ada9fc/cargo_ament_build-0.1.9-py3-none-musllinux_1_2_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6931ad0fa220ac8c3df1cb18910030adad63e4caef87d3847dd741aab02089de",
"md5": "757a9a3a124e37364f4f3f3b7e4e8da4",
"sha256": "f08aff52c8a3d810fb589c9b2ea2d66da0d006149d722710fc278e440015eef3"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-musllinux_1_2_x86_64.whl",
"has_sig": false,
"md5_digest": "757a9a3a124e37364f4f3f3b7e4e8da4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 676483,
"upload_time": "2024-10-16T09:38:47",
"upload_time_iso_8601": "2024-10-16T09:38:47.946264Z",
"url": "https://files.pythonhosted.org/packages/69/31/ad0fa220ac8c3df1cb18910030adad63e4caef87d3847dd741aab02089de/cargo_ament_build-0.1.9-py3-none-musllinux_1_2_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "cf34a9733d9b63d22f95d6c12f3830b0ecc4ea88d35fa62694f0ec9ceadb877a",
"md5": "a561a8a67c954f5867f59b7d1543cecb",
"sha256": "00a6e6afa3acb03872c22af4d0d28174bc4bcb349fc26e3d6fe2b005cdef2286"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-win32.whl",
"has_sig": false,
"md5_digest": "a561a8a67c954f5867f59b7d1543cecb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 468652,
"upload_time": "2024-10-16T09:38:51",
"upload_time_iso_8601": "2024-10-16T09:38:51.126378Z",
"url": "https://files.pythonhosted.org/packages/cf/34/a9733d9b63d22f95d6c12f3830b0ecc4ea88d35fa62694f0ec9ceadb877a/cargo_ament_build-0.1.9-py3-none-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "992d339b41c8636a4cfb8de368e3273d7e5eb084b2f982506738f7e153423a07",
"md5": "70ee0b055dda74e04da8021a497c1ee2",
"sha256": "c5c2fe295609f48fc7032e717b10327d79185c55b7ef1cf0870f7f6bf77b1fe1"
},
"downloads": -1,
"filename": "cargo_ament_build-0.1.9-py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "70ee0b055dda74e04da8021a497c1ee2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 497743,
"upload_time": "2024-10-16T09:38:49",
"upload_time_iso_8601": "2024-10-16T09:38:49.147476Z",
"url": "https://files.pythonhosted.org/packages/99/2d/339b41c8636a4cfb8de368e3273d7e5eb084b2f982506738f7e153423a07/cargo_ament_build-0.1.9-py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 09:38:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ros2-rust",
"github_project": "cargo-ament-build",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cargo-ament-build"
}
JSON
