colcon-dashboard 0.3.0__tar.gz

colcon_dashboard-0.3.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

colcon_dashboard-0.3.0/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: colcon-dashboard
+Version: 0.3.0
+Summary: Live web dashboard for colcon builds: dependency graph, timeline, per-package logs, system pressure
+Author-email: Mete Fatih Cırıt <mfc@autoware.org>
+License: Apache-2.0
+Project-URL: Repository, https://github.com/autowarefoundation/colcon-dashboard
+Project-URL: Issues, https://github.com/autowarefoundation/colcon-dashboard/issues
+Keywords: colcon,ros,ros2,build,dashboard,autoware
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Colcon Dashboard
+
+A live web dashboard for `colcon build`. It shows how many packages are done, building, ready, waiting, or failed. It draws the dependency graph and colors each node as the build moves through it. Each package gets its own log pane, so logs never mix.
+
+The server is one Python file. It uses only the standard library. It works on any colcon workspace, because it reads the `events.log` and `logger_all.log` files that colcon writes under `log/` for every build.
+
+## Install
+
+The package has two parts: the `colcon-dashboard` command, and a colcon plugin that can start the dashboard when `colcon build` runs.
+
+On Ubuntu, install the apt package from the PPA. This is the official method. It puts the plugin in the same Python environment as the apt colcon, where colcon finds it:
+
+```bash
+sudo add-apt-repository ppa:xmfcx/colcon-dashboard
+sudo apt install python3-colcon-dashboard
+```
+
+For other setups, install from PyPI into the environment that runs colcon:
+
+- colcon in a virtualenv or a conda environment: `pip install colcon-dashboard` in that environment.
+- colcon installed with pipx: `pipx inject colcon-common-extensions colcon-dashboard`.
+- For the `colcon-dashboard` command alone, without the plugin: `pipx install colcon-dashboard`.
+
+To install from a checkout, replace the package name with the path to this repository.
+
+## Quick start
+
+Run a build with the dashboard switched on. The plugin starts it and prints its address:
+
+```text
+$ colcon build --event-handlers dashboard+
+[colcon-dashboard] dashboard: http://127.0.0.1:8635/
+```
+
+The plugin stays off by default, so a plain `colcon build` starts no server.
+
+For daily use, turn it on once. Pick one of these:
+
+Add this line to your `~/.bashrc`:
+
+```bash
+export COLCON_DASHBOARD=1
+```
+
+Or enable the handler in `~/.colcon/defaults.yaml`:
+
+```yaml
+build:
+  event-handlers: [dashboard+]
+```
+
+After that, every `colcon build` starts the dashboard, or reuses the one that already runs for the workspace. The command line toggle wins over the environment default in both directions.
+
+Each workspace gets exactly one server, on a stable port derived from the workspace path. A second `colcon build` reuses it, and a file lock refuses duplicate servers. The server keeps running after the build, so the page stays available for the next build and for post-mortems.
+
+You can also run it by hand, with or without the plugin:
+
+```bash
+colcon-dashboard ~/projects/autoware          # start, or print the running URL
+colcon-dashboard ~/projects/autoware --stop   # stop this workspace's server
+colcon-dashboard --list                       # all running servers
+colcon-dashboard --stop-all                   # stop every server
+```
+
+The server follows `log/latest_build`. If a new build starts in the same workspace, the page switches to it and shows a notice.
+
+## What the page shows
+
+### Header
+
+The header shows the workspace path, the build id, a LIVE / COMPLETE / FAILED / STOPPED badge, and the parallel worker count.
+
+The right side is the system strip. A colcon build can exhaust the machine, so pressure stays visible at all times:
+
+- A per-core heatmap, one cell per core. Cell color runs from the idle gray to full blue at 100% use. Hover a cell for the exact number.
+- CPU, RAM, and swap meters. A fill turns amber under pressure (CPU 85%, RAM 75%, swap 30%) and red near the limit (96%, 90%, 70%). At red the label also turns red and bold.
+- Hover the CPU meter for the load average. Hover the RAM meter for the exact percentage.
+
+### Progress strip
+
+The meter fills as the build advances: green for done, animated blue stripes for building, red for failed, orange for aborted.
+
+The tiles count each state: done of total, building, ready, waiting (plus a blocked count after a failure), failed, aborted, and skipped. Elapsed time and the rate in packages per minute sit at the end.
+
+### Dependency graph
+
+Every package in the build, laid out left to right by dependency depth. An edge points from a dependency to the package that needs it.
+
+Node states combine color, border, and motion:
+
+- **Done**: a green wash.
+- **Building**: a blue box that slowly breathes, desynced per node. The box fills left to right with a deeper blue as make reports `[ 42%]` progress, and the label stays legible on top.
+- **Ready**: a dashed blue border. All dependencies are done, and the package starts as soon as a worker frees.
+- **Next up**: a slow pulse. This waiting package starts when the packages that build now finish, because no deeper dependency blocks it.
+- **Waiting**: quiet gray. **Skipped**: gray with a struck label.
+- **Failed**: solid red. Everything downstream of a failure turns red-dashed with red edges. This blast radius stays distinct from packages that were merely abandoned when the build stopped.
+- **Aborted**: orange. The package was building when the build stopped.
+
+Edges take color from their endpoints:
+
+- Light green between two done packages: finished lineage.
+- Solid blue into a building package, with droplets that flow along the edge at constant speed: the package consumes its finished dependencies.
+- Dashed blue marching into a next-up package: what it waits for.
+- Red along the failure cascade.
+
+Interaction:
+
+- Hover a node to see its state, phase, time, stderr count, and path, and to light its full dependency chain while the rest dims.
+- Click a node to open its log pane.
+- Drag to pan, scroll to zoom. **Fit** frames the whole graph. **Frontier** zooms to what builds now.
+- **This build / All packages** switches between the build's packages and the whole workspace.
+- When most package names share a prefix such as `autoware_`, the labels hide it. Tooltips keep the full name.
+
+### Layout modes
+
+The **layout** menu picks one of three modes, and the choice persists:
+
+- `layered`: the static left-to-right layout described above.
+- `force`: a live spring simulation with the same left-to-right anchoring. Drag nodes to rearrange. The simulation cools and stops by itself.
+- `3d`: the build as a wavefront. Building packages share one central plane, finished discs stack to its left, and waiting discs queue to the right by dependency depth. Packages glide through the blue plane as the build advances. Left-drag orbits, shift-drag or right-drag or middle-drag pans, the wheel zooms, and the camera rotates by itself until the first grab.
+
+Fit and Frontier drive the camera in every mode. In the force and 3D modes, a **spread** slider in the corner scales how far the simulation spreads the nodes.
+
+### Timeline
+
+A Gantt chart of every started package, sorted by start time, with a time axis and a dashed now line. Bar colors match the graph states.
+
+The chart makes the parallelism and the long serial chains visible. It auto-scrolls to the newest bars as they start; scroll up to release, or use the **⤓ follow new** toggle.
+
+### Log panes
+
+The dock opens with a pinned **build log** tab: the whole build as a terminal would show it, with `Starting >>>` and `Finished <<<` lines between every package's output. Click any package in the graph or the timeline to open its own tab next to it. Each tab has its own scrollback, so logs never interleave.
+
+- A pane follows new output until you scroll up. The **⤓ follow** button re-engages.
+- Panes open at the tail for an instant start. **⤒ load all** fetches the whole history in one click.
+- Every line carries a timestamp: build-relative in the build log, job-relative in package panes. The **🕒 ts** button hides them.
+- The **search** box filters as you type: matching lines highlight, Enter and Shift+Enter step through them, and the search stays live while the log streams.
+- A selector switches a package pane between the timestamped output, `stdout+stderr`, `stderr`, `stdout`, and the command log.
+- ANSI colors render as in a terminal: the 16 classic colors, 256-color, and truecolor, with palettes tuned per theme. Uncolored lines that match error or warning patterns still get color.
+- When a package fails, its pane opens by itself and a toast points to it.
+- Drag the bar above the dock to resize it.
+
+### Theme
+
+The page follows the system theme. The ◐ button cycles system, light, and dark. Every view recolors instantly, including the 3D canvas.
+
+## How it works
+
+colcon writes a structured event stream to `log/<build>/events.log`. The server tails this file and reconstructs the exact job set from it. `JobQueued` events carry the full dependency closure of each job, as colcon resolved it. `JobStarted`, `JobEnded`, and `JobSkipped` events give the state machine. `TimerEvent` heartbeats give liveness, so the LIVE badge does not depend on process inspection.
+
+The graph shows direct edges, not the full closure. The server computes the transitive reduction of colcon's per-job dependency sets. Package metadata (path, build type) and the edges of packages outside the current build come from a scan of the `package.xml` files in the workspace.
+
+Per-package logs come from `log/<build>/<package>/`. The server serves them incrementally by byte offset, so an open pane costs one small request per second.
+
+## Options
+
+| Flag | Default | Meaning |
+|---|---|---|
+| `workspace` | `.` | Colcon workspace root (positional) |
+| `--port` | stable per-workspace port | HTTP port. The default falls back to a free port when taken |
+| `--host` | `127.0.0.1` | Bind address. Use `0.0.0.0` to reach the page from another machine |
+| `--log-base` | `log` | Log directory, relative to the workspace |
+| `--stop` | | Stop the server that watches this workspace |
+| `--list` | | List the running servers of all workspaces |
+| `--stop-all` | | Stop the servers of all workspaces |
+
+## API
+
+| Endpoint | Returns |
+|---|---|
+| `/api/state` | Job states, counts, timings, build metadata |
+| `/api/graph` | Direct dependency edges for the graph views |
+| `/api/builds` | The `build_*` directories under the log base |
+| `/api/log/<pkg>?offset=N&file=combined` | A log chunk from byte `N`, plus the new offset |
+
+## Limits
+
+- One server watches one workspace, and a lock enforces it. Each workspace gets its own server and port.
+- The page follows the latest build. Finished builds stay readable until a new build starts.
+- The server trusts the local workspace. Do not expose the port to an untrusted network.

colcon_dashboard-0.3.0/README.md

@@ -0,0 +1,180 @@
+# Colcon Dashboard
+
+A live web dashboard for `colcon build`. It shows how many packages are done, building, ready, waiting, or failed. It draws the dependency graph and colors each node as the build moves through it. Each package gets its own log pane, so logs never mix.
+
+The server is one Python file. It uses only the standard library. It works on any colcon workspace, because it reads the `events.log` and `logger_all.log` files that colcon writes under `log/` for every build.
+
+## Install
+
+The package has two parts: the `colcon-dashboard` command, and a colcon plugin that can start the dashboard when `colcon build` runs.
+
+On Ubuntu, install the apt package from the PPA. This is the official method. It puts the plugin in the same Python environment as the apt colcon, where colcon finds it:
+
+```bash
+sudo add-apt-repository ppa:xmfcx/colcon-dashboard
+sudo apt install python3-colcon-dashboard
+```
+
+For other setups, install from PyPI into the environment that runs colcon:
+
+- colcon in a virtualenv or a conda environment: `pip install colcon-dashboard` in that environment.
+- colcon installed with pipx: `pipx inject colcon-common-extensions colcon-dashboard`.
+- For the `colcon-dashboard` command alone, without the plugin: `pipx install colcon-dashboard`.
+
+To install from a checkout, replace the package name with the path to this repository.
+
+## Quick start
+
+Run a build with the dashboard switched on. The plugin starts it and prints its address:
+
+```text
+$ colcon build --event-handlers dashboard+
+[colcon-dashboard] dashboard: http://127.0.0.1:8635/
+```
+
+The plugin stays off by default, so a plain `colcon build` starts no server.
+
+For daily use, turn it on once. Pick one of these:
+
+Add this line to your `~/.bashrc`:
+
+```bash
+export COLCON_DASHBOARD=1
+```
+
+Or enable the handler in `~/.colcon/defaults.yaml`:
+
+```yaml
+build:
+  event-handlers: [dashboard+]
+```
+
+After that, every `colcon build` starts the dashboard, or reuses the one that already runs for the workspace. The command line toggle wins over the environment default in both directions.
+
+Each workspace gets exactly one server, on a stable port derived from the workspace path. A second `colcon build` reuses it, and a file lock refuses duplicate servers. The server keeps running after the build, so the page stays available for the next build and for post-mortems.
+
+You can also run it by hand, with or without the plugin:
+
+```bash
+colcon-dashboard ~/projects/autoware          # start, or print the running URL
+colcon-dashboard ~/projects/autoware --stop   # stop this workspace's server
+colcon-dashboard --list                       # all running servers
+colcon-dashboard --stop-all                   # stop every server
+```
+
+The server follows `log/latest_build`. If a new build starts in the same workspace, the page switches to it and shows a notice.
+
+## What the page shows
+
+### Header
+
+The header shows the workspace path, the build id, a LIVE / COMPLETE / FAILED / STOPPED badge, and the parallel worker count.
+
+The right side is the system strip. A colcon build can exhaust the machine, so pressure stays visible at all times:
+
+- A per-core heatmap, one cell per core. Cell color runs from the idle gray to full blue at 100% use. Hover a cell for the exact number.
+- CPU, RAM, and swap meters. A fill turns amber under pressure (CPU 85%, RAM 75%, swap 30%) and red near the limit (96%, 90%, 70%). At red the label also turns red and bold.
+- Hover the CPU meter for the load average. Hover the RAM meter for the exact percentage.
+
+### Progress strip
+
+The meter fills as the build advances: green for done, animated blue stripes for building, red for failed, orange for aborted.
+
+The tiles count each state: done of total, building, ready, waiting (plus a blocked count after a failure), failed, aborted, and skipped. Elapsed time and the rate in packages per minute sit at the end.
+
+### Dependency graph
+
+Every package in the build, laid out left to right by dependency depth. An edge points from a dependency to the package that needs it.
+
+Node states combine color, border, and motion:
+
+- **Done**: a green wash.
+- **Building**: a blue box that slowly breathes, desynced per node. The box fills left to right with a deeper blue as make reports `[ 42%]` progress, and the label stays legible on top.
+- **Ready**: a dashed blue border. All dependencies are done, and the package starts as soon as a worker frees.
+- **Next up**: a slow pulse. This waiting package starts when the packages that build now finish, because no deeper dependency blocks it.
+- **Waiting**: quiet gray. **Skipped**: gray with a struck label.
+- **Failed**: solid red. Everything downstream of a failure turns red-dashed with red edges. This blast radius stays distinct from packages that were merely abandoned when the build stopped.
+- **Aborted**: orange. The package was building when the build stopped.
+
+Edges take color from their endpoints:
+
+- Light green between two done packages: finished lineage.
+- Solid blue into a building package, with droplets that flow along the edge at constant speed: the package consumes its finished dependencies.
+- Dashed blue marching into a next-up package: what it waits for.
+- Red along the failure cascade.
+
+Interaction:
+
+- Hover a node to see its state, phase, time, stderr count, and path, and to light its full dependency chain while the rest dims.
+- Click a node to open its log pane.
+- Drag to pan, scroll to zoom. **Fit** frames the whole graph. **Frontier** zooms to what builds now.
+- **This build / All packages** switches between the build's packages and the whole workspace.
+- When most package names share a prefix such as `autoware_`, the labels hide it. Tooltips keep the full name.
+
+### Layout modes
+
+The **layout** menu picks one of three modes, and the choice persists:
+
+- `layered`: the static left-to-right layout described above.
+- `force`: a live spring simulation with the same left-to-right anchoring. Drag nodes to rearrange. The simulation cools and stops by itself.
+- `3d`: the build as a wavefront. Building packages share one central plane, finished discs stack to its left, and waiting discs queue to the right by dependency depth. Packages glide through the blue plane as the build advances. Left-drag orbits, shift-drag or right-drag or middle-drag pans, the wheel zooms, and the camera rotates by itself until the first grab.
+
+Fit and Frontier drive the camera in every mode. In the force and 3D modes, a **spread** slider in the corner scales how far the simulation spreads the nodes.
+
+### Timeline
+
+A Gantt chart of every started package, sorted by start time, with a time axis and a dashed now line. Bar colors match the graph states.
+
+The chart makes the parallelism and the long serial chains visible. It auto-scrolls to the newest bars as they start; scroll up to release, or use the **⤓ follow new** toggle.
+
+### Log panes
+
+The dock opens with a pinned **build log** tab: the whole build as a terminal would show it, with `Starting >>>` and `Finished <<<` lines between every package's output. Click any package in the graph or the timeline to open its own tab next to it. Each tab has its own scrollback, so logs never interleave.
+
+- A pane follows new output until you scroll up. The **⤓ follow** button re-engages.
+- Panes open at the tail for an instant start. **⤒ load all** fetches the whole history in one click.
+- Every line carries a timestamp: build-relative in the build log, job-relative in package panes. The **🕒 ts** button hides them.
+- The **search** box filters as you type: matching lines highlight, Enter and Shift+Enter step through them, and the search stays live while the log streams.
+- A selector switches a package pane between the timestamped output, `stdout+stderr`, `stderr`, `stdout`, and the command log.
+- ANSI colors render as in a terminal: the 16 classic colors, 256-color, and truecolor, with palettes tuned per theme. Uncolored lines that match error or warning patterns still get color.
+- When a package fails, its pane opens by itself and a toast points to it.
+- Drag the bar above the dock to resize it.
+
+### Theme
+
+The page follows the system theme. The ◐ button cycles system, light, and dark. Every view recolors instantly, including the 3D canvas.
+
+## How it works
+
+colcon writes a structured event stream to `log/<build>/events.log`. The server tails this file and reconstructs the exact job set from it. `JobQueued` events carry the full dependency closure of each job, as colcon resolved it. `JobStarted`, `JobEnded`, and `JobSkipped` events give the state machine. `TimerEvent` heartbeats give liveness, so the LIVE badge does not depend on process inspection.
+
+The graph shows direct edges, not the full closure. The server computes the transitive reduction of colcon's per-job dependency sets. Package metadata (path, build type) and the edges of packages outside the current build come from a scan of the `package.xml` files in the workspace.
+
+Per-package logs come from `log/<build>/<package>/`. The server serves them incrementally by byte offset, so an open pane costs one small request per second.
+
+## Options
+
+| Flag | Default | Meaning |
+|---|---|---|
+| `workspace` | `.` | Colcon workspace root (positional) |
+| `--port` | stable per-workspace port | HTTP port. The default falls back to a free port when taken |
+| `--host` | `127.0.0.1` | Bind address. Use `0.0.0.0` to reach the page from another machine |
+| `--log-base` | `log` | Log directory, relative to the workspace |
+| `--stop` | | Stop the server that watches this workspace |
+| `--list` | | List the running servers of all workspaces |
+| `--stop-all` | | Stop the servers of all workspaces |
+
+## API
+
+| Endpoint | Returns |
+|---|---|
+| `/api/state` | Job states, counts, timings, build metadata |
+| `/api/graph` | Direct dependency edges for the graph views |
+| `/api/builds` | The `build_*` directories under the log base |
+| `/api/log/<pkg>?offset=N&file=combined` | A log chunk from byte `N`, plus the new offset |
+
+## Limits
+
+- One server watches one workspace, and a lock enforces it. Each workspace gets its own server and port.
+- The page follows the latest build. Finished builds stay readable until a new build starts.
+- The server trusts the local workspace. Do not expose the port to an untrusted network.

colcon_dashboard-0.3.0/colcon_dashboard/__init__.py

@@ -0,0 +1,3 @@
+"""Colcon Dashboard: a live web dashboard for colcon builds."""
+
+__version__ = "0.3.0"

colcon_dashboard-0.3.0/colcon_dashboard/__main__.py

@@ -0,0 +1,3 @@
+from .server import main
+
+main()

colcon_dashboard-0.3.0/colcon_dashboard/event_handler.py

@@ -0,0 +1,42 @@
+"""colcon event handler that spawns the dashboard when a build starts.
+
+Loaded by colcon through the `colcon_core.event_handler` entry point. The
+handler is off by default: enable it for one build with
+`--event-handlers dashboard+`, for every build with
+`COLCON_DASHBOARD=1`, or through `~/.colcon/defaults.yaml`. The
+command line toggle always wins over the environment default.
+"""
+
+import os
+
+from colcon_core.event_handler import EventHandlerExtensionPoint
+from colcon_core.plugin_system import satisfies_version
+
+
+class DashboardEventHandler(EventHandlerExtensionPoint):
+    """Serve a live web dashboard for this build."""
+
+    def __init__(self):  # noqa: D107
+        super().__init__()
+        satisfies_version(
+            EventHandlerExtensionPoint.EXTENSION_POINT_VERSION, "^1.0")
+        # off by default: starting a server must be a choice, not a surprise
+        self.enabled = os.environ.get(
+            "COLCON_DASHBOARD", "").lower() in ("1", "yes", "true", "on")
+        self._done = False
+
+    def __call__(self, event):  # noqa: D102
+        if self._done:
+            return
+        self._done = True
+        args = getattr(self.context, "args", None)
+        if getattr(args, "verb_name", None) != "build":
+            return
+        try:
+            # imported lazily: never let the dashboard break a build
+            from colcon_dashboard.server import ensure_running
+            url, _started = ensure_running(os.getcwd())
+            if url:
+                print(f"[colcon-dashboard] dashboard: {url}")
+        except Exception:  # noqa: BLE001
+            pass