colcon-devtools

0.3.0 · active · verified Fri Apr 17

colcon-devtools is an extension for the `colcon` build tool, providing commands and information about `colcon`'s extension points and installed extensions. It is currently at version 0.3.0. Its release cadence is generally aligned with the development of `colcon` itself, often releasing new versions alongside `colcon` or when new features or fixes are needed for its core functionality.

Common errors

```
colcon: command not found
```
cause The `colcon` executable is not installed or not in your system's PATH. `colcon-devtools` provides extensions *to* `colcon`, not a standalone executable.

fix First install `colcon-core`: `pip install colcon-core`. Ensure your Python environment's scripts directory is in your system's PATH.
```
colcon: error: unrecognized arguments: devtools
```
cause The `colcon-devtools` package is not correctly installed or `colcon` cannot find its extensions. This often happens if installed in a different virtual environment or if there's an issue with the `colcon` extension discovery mechanism.

fix Ensure both `colcon-core` and `colcon-devtools` are installed in the same Python environment: `pip install colcon-core colcon-devtools --upgrade`.

Warnings

gotcha `colcon-devtools` commands are subcommands of `colcon`. They will not be available if `colcon-core` is not installed or not accessible in your PATH.
Fix: Ensure `colcon-core` is installed in the same Python environment: `pip install colcon-core colcon-devtools`
gotcha As an extension, `colcon-devtools` relies on the internal APIs of `colcon-core`. Significant changes in `colcon-core`'s major versions might require an update to `colcon-devtools` for compatibility, even if it doesn't explicitly declare a strict version dependency.
Fix: If encountering issues after updating `colcon-core`, try upgrading `colcon-devtools` to its latest version: `pip install colcon-devtools --upgrade`

Install

pip install colcon-devtools Install `colcon-devtools`

Quickstart

This quickstart first installs both `colcon-core` and `colcon-devtools`, then demonstrates a core functionality: listing all discovered `colcon` extensions, including those provided by `colcon-devtools`, with verbose output.

pip install colcon-core colcon-devtools
colcon devtools extensions --verb

view raw JSON →