dear-ros-node-viewer


Namedear-ros-node-viewer JSON
Version 1.0.0 PyPI version JSON
download
home_page
Summarydear_ros_node_viewer
upload_time2023-11-04 18:55:12
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords ros ros2 tool rqt_graph dearpygui node-editor
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <h1 align="center">
  <img src="https://github.com/iwatake2222/dear_ros_node_viewer/raw/main/00_docs/logo.png" alt="Dear RosNodeViewer logo"></a>
</h1>

https://user-images.githubusercontent.com/105265012/177068238-eaf4fed9-12c0-4c5b-ac7f-9597483c4c3c.mp4

[![Python application](https://github.com/iwatake2222/dear_ros_node_viewer/actions/workflows/python-app.yml/badge.svg)](https://github.com/iwatake2222/dear_ros_node_viewer/actions/workflows/python-app.yml)
[![PyPI Publish](https://github.com/iwatake2222/dear_ros_node_viewer/actions/workflows/pypi-publish.yml/badge.svg)](https://pypi.org/project/dear-ros-node-viewer/)

# Dear RosNodeViewer
## About
- Visualize ROS2 node diagram
- Support the following sources:
  - *architecture.yaml* generated by [CARET](https://github.com/tier4/caret)
  - *rosgraph.dot* generated by rqt_graph
  - running ROS graph analysis

## Requirements
- Ubuntu 20.04 or 22.04
  - graphviz is required
- optional: ROS 2 Galactic or Humble if you need runtime ROS graph analysis
- Not tested in Windows / Mac

## Get Started
```sh
# Install requirements
sudo apt install graphviz

# Install Dear RosNodeViewer
pip install dear-ros-node-viewer

# Download sample graph
wget https://raw.githubusercontent.com/iwatake2222/dear_ros_node_viewer/main/sample/architecture_autoware.yaml

# Run Dear RosNodeViewer
dear_ros_node_viewer architecture_autoware.yaml
```

- Quick operation guide:
  - Middle button drag: move graph area
  - Mouse scroll: zoom in/out (zoom function is tentative)


## How to Use
[See WiKi](https://github.com/iwatake2222/dear_ros_node_viewer/wiki/01.-How-to-Use)


# Acknowledgements
- Dear RosNodeViewer utilizes [Dear PyGui](https://github.com/hoffstadt/DearPyGui)
  - *Dear RosNodeViewer* is named in honor of Dear PyGui
- Dear RosNodeViewer contains [Roboto font](https://fonts.google.com/specimen/Roboto)
  - licensed under the Apache License, Version 2.0.

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "dear-ros-node-viewer",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "iwatake2222 <take.iwiw2222@gmail.com>",
    "keywords": "ros,ros2,tool,rqt_graph,dearpygui,node-editor",
    "author": "",
    "author_email": "iwatake2222 <take.iwiw2222@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/15/3f/18b258960120ca1df936e18a59709b61a2ae9a7e26368d1b43ec686bc531/dear_ros_node_viewer-1.0.0.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">\n  <img src=\"https://github.com/iwatake2222/dear_ros_node_viewer/raw/main/00_docs/logo.png\" alt=\"Dear RosNodeViewer logo\"></a>\n</h1>\n\nhttps://user-images.githubusercontent.com/105265012/177068238-eaf4fed9-12c0-4c5b-ac7f-9597483c4c3c.mp4\n\n[![Python application](https://github.com/iwatake2222/dear_ros_node_viewer/actions/workflows/python-app.yml/badge.svg)](https://github.com/iwatake2222/dear_ros_node_viewer/actions/workflows/python-app.yml)\n[![PyPI Publish](https://github.com/iwatake2222/dear_ros_node_viewer/actions/workflows/pypi-publish.yml/badge.svg)](https://pypi.org/project/dear-ros-node-viewer/)\n\n# Dear RosNodeViewer\n## About\n- Visualize ROS2 node diagram\n- Support the following sources:\n  - *architecture.yaml* generated by [CARET](https://github.com/tier4/caret)\n  - *rosgraph.dot* generated by rqt_graph\n  - running ROS graph analysis\n\n## Requirements\n- Ubuntu 20.04 or 22.04\n  - graphviz is required\n- optional: ROS 2 Galactic or Humble if you need runtime ROS graph analysis\n- Not tested in Windows / Mac\n\n## Get Started\n```sh\n# Install requirements\nsudo apt install graphviz\n\n# Install Dear RosNodeViewer\npip install dear-ros-node-viewer\n\n# Download sample graph\nwget https://raw.githubusercontent.com/iwatake2222/dear_ros_node_viewer/main/sample/architecture_autoware.yaml\n\n# Run Dear RosNodeViewer\ndear_ros_node_viewer architecture_autoware.yaml\n```\n\n- Quick operation guide:\n  - Middle button drag: move graph area\n  - Mouse scroll: zoom in/out (zoom function is tentative)\n\n\n## How to Use\n[See WiKi](https://github.com/iwatake2222/dear_ros_node_viewer/wiki/01.-How-to-Use)\n\n\n# Acknowledgements\n- Dear RosNodeViewer utilizes [Dear PyGui](https://github.com/hoffstadt/DearPyGui)\n  - *Dear RosNodeViewer* is named in honor of Dear PyGui\n- Dear RosNodeViewer contains [Roboto font](https://fonts.google.com/specimen/Roboto)\n  - licensed under the Apache License, Version 2.0.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "dear_ros_node_viewer",
    "version": "1.0.0",
    "project_urls": {
        "Bug Reports": "https://github.com/iwatake2222/dear_ros_node_viewer/issues",
        "Homepage": "https://github.com/iwatake2222/dear_ros_node_viewer",
        "Source": "https://github.com/iwatake2222/dear_ros_node_viewer"
    },
    "split_keywords": [
        "ros",
        "ros2",
        "tool",
        "rqt_graph",
        "dearpygui",
        "node-editor"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c0712254e8e83cd3e38cde0e4fcc281773007f0f73c5b6bf32be969e39c973b5",
                "md5": "dddc2dbedaf052ed42a7d72cf194fd64",
                "sha256": "f52185bca5c2536015a9b8ba6fd85d3741555eb9291268c8137188cc5910b5f3"
            },
            "downloads": -1,
            "filename": "dear_ros_node_viewer-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dddc2dbedaf052ed42a7d72cf194fd64",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 120556,
            "upload_time": "2023-11-04T18:55:10",
            "upload_time_iso_8601": "2023-11-04T18:55:10.744860Z",
            "url": "https://files.pythonhosted.org/packages/c0/71/2254e8e83cd3e38cde0e4fcc281773007f0f73c5b6bf32be969e39c973b5/dear_ros_node_viewer-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "153f18b258960120ca1df936e18a59709b61a2ae9a7e26368d1b43ec686bc531",
                "md5": "a01b8501337084a6039f500d665bc81e",
                "sha256": "743de039f69e5a11707a5529dcb1f6b6677bf80f1a37a940054c963e7eceba09"
            },
            "downloads": -1,
            "filename": "dear_ros_node_viewer-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a01b8501337084a6039f500d665bc81e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 249476,
            "upload_time": "2023-11-04T18:55:12",
            "upload_time_iso_8601": "2023-11-04T18:55:12.231841Z",
            "url": "https://files.pythonhosted.org/packages/15/3f/18b258960120ca1df936e18a59709b61a2ae9a7e26368d1b43ec686bc531/dear_ros_node_viewer-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-04 18:55:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "iwatake2222",
    "github_project": "dear_ros_node_viewer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "dear-ros-node-viewer"
}
Elapsed time: 0.13666s