Convert ROS systems to Markdown for LLM processing
Project description
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
[!Note] This repository started as an experiment to see how good current AI tools are at creating complex projects. The vast majority of code was generated by AI (Cursor with Claude 3.5 Sonnet), with almost no code written directly by the authors. That said, the authors did write the documentation and project structure, and spent a lot of time iterating with the AI to make it all work. Lessons learned will follow once the project nears completion.
License
Apache 2.0
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ros_to_markdown-0.1.0.tar.gz.
File metadata
- Download URL: ros_to_markdown-0.1.0.tar.gz
- Upload date:
- Size: 17.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
356fef4f871d0a730a4b11d731483b544ee26aa2a32e9ba714edb536008f6c2f
|
|
| MD5 |
f6865833deb89494e3479f9a486ce4d8
|
|
| BLAKE2b-256 |
beff731f871881d839a125d294f5de179d3b409e3b1aa4b22d4f5a155879a6c8
|
Provenance
The following attestation bundles were made for ros_to_markdown-0.1.0.tar.gz:
Publisher:
workflow.yml on RobRoyce/ros_to_markdown
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ros_to_markdown-0.1.0.tar.gz -
Subject digest:
356fef4f871d0a730a4b11d731483b544ee26aa2a32e9ba714edb536008f6c2f - Sigstore transparency entry: 165768137
- Sigstore integration time:
-
Permalink:
RobRoyce/ros_to_markdown@561219cc54ad6c1490c16e96560008b0679e6034 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/RobRoyce
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
workflow.yml@561219cc54ad6c1490c16e96560008b0679e6034 -
Trigger Event:
release
-
Statement type:
File details
Details for the file ros_to_markdown-0.1.0-py3-none-any.whl.
File metadata
- Download URL: ros_to_markdown-0.1.0-py3-none-any.whl
- Upload date:
- Size: 6.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2c5804c412c9914d62b66efbb2a78b8a45f7ddcf89c4c2f6878c7b868e195a3b
|
|
| MD5 |
7952a61d287403c07ea4e5872c68470c
|
|
| BLAKE2b-256 |
0d3082905657baee0df9f58fb000fc46ea1775a1e6e4f28c005ef7a08ca15bb6
|
Provenance
The following attestation bundles were made for ros_to_markdown-0.1.0-py3-none-any.whl:
Publisher:
workflow.yml on RobRoyce/ros_to_markdown
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ros_to_markdown-0.1.0-py3-none-any.whl -
Subject digest:
2c5804c412c9914d62b66efbb2a78b8a45f7ddcf89c4c2f6878c7b868e195a3b - Sigstore transparency entry: 165768140
- Sigstore integration time:
-
Permalink:
RobRoyce/ros_to_markdown@561219cc54ad6c1490c16e96560008b0679e6034 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/RobRoyce
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
workflow.yml@561219cc54ad6c1490c16e96560008b0679e6034 -
Trigger Event:
release
-
Statement type:
