Registry / devops / colcon-output

colcon-output

JSON →
library0.2.14pypypiunverified

colcon-output is an extension for the colcon build tool, primarily used in the ROS ecosystem, to customize and enhance the terminal output in various ways. It provides alternative output formats like 'log' for more detailed logs and 'json' for machine-readable output. The current version is 0.2.14, and it follows an infrequent, feature-driven release cadence, typically aligning with `colcon-core` updates.

pip install colcon-output
INSTALL
IMPORT
SIG · COLCON-OUTPUT
C
colcon-output
devopspythonv0.2.14
Install
5.1s avg
Import
Disk
40MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v0.2.14 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.910 runs
installs and imports cleanly · install 0.0s · import 0.000s · 37.5MB
glibc
py 3.103.910 runs
installs and imports cleanly · install 5.1s · import 0.000s · 38MB
40MB installed
● package 40MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

colcon-output functionality
Functionality is enabled via colcon CLI arguments or configuration, not direct Python imports.
from colcon_output import SomeClass
colcon-output is a colcon extension, not a library meant for direct programmatic import by end-user applications. Its features are accessed through the `colcon` command-line interface.

This quickstart demonstrates how to use the `colcon-output` extension by specifying different output formats during a `colcon build` command. The `--output-format` argument allows you to switch between available formats like `standard`, `log`, `json`, or `json_verbose`.

# Assuming you have a colcon workspace with a package (e.g., 'my_package') # Build with the 'log' output format for detailed messages # (Often used in CI/CD or when debugging verbose output) colcon build --packages-select my_package --output-format log # Build with the 'json' output format for machine-readable results # (Useful for parsing build status in scripts) colcon build --packages-select my_package --output-format json
colcon --version
Debug
Known issues
gotchacolcon-output is an extension, not a standalone library. Trying to `import colcon_output` directly in user scripts for its functionality will not work as expected, as its features are exposed through the `colcon` CLI.
fix
Access `colcon-output` features through `colcon` command-line arguments (e.g., `--output-format`) or `colcon` configuration files, not via direct Python imports in user code.
affects: All versions
gotchaColor output may appear inconsistent or be disabled in certain terminal environments or CI/CD pipelines. This can be influenced by terminal capabilities or specific environment variables.
fix
For fine-tuning color darkening, set the `COLCON_COLOR_DARKEN_THRESHOLD` environment variable (e.g., `export COLCON_COLOR_DARKEN_THRESHOLD=10`). Ensure your terminal supports 256-color output. In CI environments, you might need to force color output if it's automatically disabled.
affects: All versions
gotchaCompatibility with `colcon-core` versions is crucial. Using an outdated `colcon-output` with a very new `colcon-core` (or vice-versa) might lead to unexpected behavior or missing features.
fix
Always ensure your `colcon-output` version is compatible with your `colcon-core` version. Check the `colcon-output` release notes and `colcon-core` documentation for specific compatibility matrices. Update both packages regularly (`pip install --upgrade colcon-core colcon-output`).
affects: <0.2.0
Upgrade
Version history
0.2.14latest on PyPI · released Mar 27, 2026
Audit
Dependencies
colcon-corerequiredcolcon-output is an extension and requires the colcon core build tool to function.
Agent activity
18 hits · last 30 days
node
18
Resources
colcon-output — pip install colcon-output · libregistry