Metadata-Version: 2.1
Name: rtui-app
Version: 0.2.1
Summary: A TUI tool for ROS1/2
Home-page: https://github.com/eduidl/rtui
License: Apache-2.0
Author: Yuma Hiramatsu
Author-email: yuma.hiramatsu@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: netifaces (>=0.11.0,<0.12.0)
Requires-Dist: numpy (>=1.23.0,<2.0.0)
Requires-Dist: rospkg (>=1.4.0,<2.0.0)
Requires-Dist: textual (>=0.40,<0.41)
Requires-Dist: typing-extensions (>=4.3.0,<5.0.0)
Project-URL: Repository, https://github.com/eduidl/rtui
Description-Content-Type: text/markdown

# rtui

[![PyPI - Version](https://img.shields.io/pypi/v/rtui-app)](https://pypi.org/project/rtui-app/)

rtui is ROS Terminal User Interface

## Support

- Python
  - 3.8+
- ROS1
  - noetic
- ROS2
  - humble
  - ironic

## Install

> **Note**  
> Package name is changed because rtui is already used by other package.  
> If you have already installed rtui, please uninstall it and install rtui-app.

Via [pipx](https://github.com/pypa/pipx) (Recommended)

```sh-session
$ pipx install rtui-app
```

Pip

```sh-session
$ pip3 install --user rtui-app
```

## Demo

[demo](https://github.com/eduidl/rtui/assets/25898373/901f58a8-98f6-4f23-82d6-404d15d5f35b)

## Usage

```
Usage: rtui [OPTIONS] COMMAND [ARGS]...

  Terminal User Interface for ROS User

Options:
  --help  Show this message and exit.

Commands:
  action   Inspect ROS actions
  node     Inspect ROS nodes (default)
  service  Inspect ROS services
  topic    Inspect ROS topics
  type     Inspect ROS types
```

- node/topic/service/action/type
  - get a list of nodes, topics, or etc.
  - get an information about specific node, topic, or etc.
  - mouse operation
    - click link of a node, a topic, or etc.
  - keyboard operation
    - `b/f`: Trace history backward and forward
    - `r`: Once more get list of nodes, topics or etc.
    - `q`: Terminate app

