Metadata-Version: 2.3
Name: ros_glint
Version: 0.2.1
Summary: Pure Python library for linting ROS packages
Project-URL: Homepage, https://github.com/MetroRobots/ros_glint
Project-URL: Bug Tracker, https://github.com/MetroRobots/ros_glint/issues
Author-email: "David V. Lu!!" <davidvlu@gmail.com>
Maintainer-email: "David V. Lu!!" <davidvlu@gmail.com>
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development
Requires-Python: >=3.8
Requires-Dist: betsy-ros
Requires-Dist: click
Requires-Dist: colorama
Requires-Dist: importlib-resources
Requires-Dist: pyyaml
Requires-Dist: ros-introspect
Provides-Extra: test
Requires-Dist: pooch; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

![ROS Glint animated logo](logo.gif)

### Make your ROS code sparkle!

ROS Glint is a linter for ROS 1 and ROS 2 packages.
It is a pure Python version of the ROS 1 package [roscompile](https://github.com/DLu/roscompile/blob/main/roscompile/README.md).

# Installation

[![PyPI version](https://badge.fury.io/py/ros-glint.svg)](https://badge.fury.io/py/ros-glint)

    sudo pip3 install ros-glint

# Running from the Command Line

Installing the Python package installs the `glint_ros` command. (Note: There's 5 million commands that start with `ros`. [citation needed] The command is `glint_ros` for ease of access/tab completion)

The command will find all ROS packages in a the current directory and attempt to run the "glinters" on them all.

```
usage: glint_ros [-h] [-f FOLDER] [-y] [-s] [linter ...]

positional arguments:
  linter                By default, run all linters. If any are specified here, only those
                        specified are run.

options:
  -h, --help            show this help message and exit
  -f FOLDER, --folder FOLDER
                        The folder to search for ROS packages in. Defaults to the current
                        directory.
  -y, --yes-to-all      Non-interactive mode that accepts all suggestions.
  -s, --skip-ros-load   Avoid loading ROS resources, useful in scripting environments.
```

# Acknowledgements
 * ROS Glint logo by [https://glowtxt.com/](https://glowtxt.com/)
