ros_to_markdown
Convert ROS systems to Markdown for LLM processing.
Overview
ros_to_markdown is a Python tool that generates comprehensive Markdown documentation from ROS1 and ROS2 systems. It can analyze:
- ROS workspaces (packages, source code)
- Running ROS systems (nodes, topics, services)
- ROS bag files
The generated documentation is optimized for consumption by LLMs and AI agents.
Installation
pip install -e .
Supported ROS Distributions
- ROS1: Noetic
- ROS2: Humble (LTS), Iron (LTS), Jazzy
Project Status
License
Apache 2.0
1 maintainer
Metadata
1 maintainer
Release files for ros-to-markdown 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ros_to_markdown-0.1.0.tar.gz | 17.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ros_to_markdown-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.4 kB
Release files / ros_to_markdown-0.1.0.tar.gz
| Download URL | ros_to_markdown-0.1.0.tar.gz |
|---|---|
| Size | 17.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
356fef4f871d0a730a4b11d731483b544ee26aa2a32e9ba714edb536008f6c2f
|
|
BLAKE2b-256 checksum How to use checksums |
beff731f871881d839a125d294f5de179d3b409e3b1aa4b22d4f5a155879a6c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 27, 2025.
Transparency logRelease files / ros_to_markdown-0.1.0-py3-none-any.whl
| Download URL | ros_to_markdown-0.1.0-py3-none-any.whl |
|---|---|
| Size | 6.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2c5804c412c9914d62b66efbb2a78b8a45f7ddcf89c4c2f6878c7b868e195a3b
|
|
BLAKE2b-256 checksum How to use checksums |
0d3082905657baee0df9f58fb000fc46ea1775a1e6e4f28c005ef7a08ca15bb6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 27, 2025.
Transparency log
