Skip to content

Commit

Permalink
chore: update chores
Browse files Browse the repository at this point in the history
Signed-off-by: iwatake2222 <[email protected]>
  • Loading branch information
iwatake2222 committed Nov 4, 2023
1 parent 1d30634 commit 68e411a
Show file tree
Hide file tree
Showing 42 changed files with 1,949 additions and 1,963 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/pypi-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel pipenv
pip install setuptools wheel pipenv build setuptools_scm
- name: Build
run: |
python setup.py sdist bdist_wheel
python3 -m build
- name: Publish a Python distribution to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/python-app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Lint with pylint
run: |
pylint ./dear_ros_node_viewer --disable=E0401
pylint ./src/dear_ros_node_viewer --disable=E0401
- name: Test with pytest
run: |
pytest --doctest-modules -v --cov=./dear_ros_node_viewer
pytest --doctest-modules -v --cov=./src/dear_ros_node_viewer
2 changes: 2 additions & 0 deletions .pylintrc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
[MAIN]
disable=too-many-public-methods
indent-string=' '
indent-after-paren=2
36 changes: 17 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,52 @@
<h1 align="center">
<img src="https://github.com/takeshi-iwanari/dear_ros_node_viewer/raw/main/00_docs/logo.png" alt="Dear RosNodeViewer logo"></a>
<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/takeshi-iwanari/dear_ros_node_viewer/actions/workflows/python-app.yml/badge.svg)](https://github.com/takeshi-iwanari/dear_ros_node_viewer/actions/workflows/python-app.yml)
[![PyPI Publish](https://github.com/takeshi-iwanari/dear_ros_node_viewer/actions/workflows/pypi-publish.yml/badge.svg)](https://pypi.org/project/dear-ros-node-viewer/)

[![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

- *architecture.yaml* generated by [CARET](https://github.com/tier4/caret)
- *rosgraph.dot* generated by rqt_graph
- running ROS graph analysis

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

- 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 graphviz-dev
sudo apt install graphviz

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

# Download sample graph
wget https://raw.githubusercontent.com/takeshi-iwanari/dear_ros_node_viewer/main/sample/architecture_autoware.yaml
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)
- Middle button drag: move graph area
- Mouse scroll: zoom in/out (zoom function is tentative)


## How to Use
[See WiKi](https://github.com/takeshi-iwanari/dear_ros_node_viewer/wiki/01.-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* 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.
- licensed under the Apache License, Version 2.0.
45 changes: 0 additions & 45 deletions dear_ros_node_viewer/__init__.py

This file was deleted.

157 changes: 0 additions & 157 deletions dear_ros_node_viewer/caret2networkx.py

This file was deleted.

Loading

0 comments on commit 68e411a

Please sign in to comment.