colcon-lint

Name	colcon-lint JSON
Version	0.3.1 JSON
	download
home_page	None
Summary	Colcon extension for linting ROS package dependencies
upload_time	2024-06-22 00:23:31
maintainer	Tatsuro Sakaguchi
docs_url	None
author	Tatsuro Sakaguchi
requires_python	>=3.10
license	Apache License, Version 2.0
keywords	colcon
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # colcon-lint

Colcon extension for linting ROS package dependencies.

This package is an extension of [colcon-core](https://github.com/colcon/colcon-core). Similar to [catkin-lint](https://github.com/fkie/catkin_lint) in ROS, it checks whether the dependencies of ROS2 packages are correctly described in the `package.xml`.

## Installation

To use this extension, please execute the following:

```bash
sudo apt install apt-rdepends
pip install colcon-lint
```

## How to use

Please execute as follows. The package specification option is the same as other colcon commands.

```bash
colcon lint --packages-select <package-name>
```

Replace `<package-name>` with the name of the package you want to check.

### Options

| Option | Description |
| --- | --- |
| package specification options | The same as other colcon commands. |
| logging options | The same as other colcon commands. |
| `--quick` | This option only checks for directly declared dependencies in the package.xml. It cannot detect dependencies that are resolved through recursively declared packages. |

## Tips

To run faster, you can build with the `-Wno-dev --trace-expand --trace-redirect=trace.log` cmake option.

```bash
colcon build --cmake-args -Wno-dev --trace-expand --trace-redirect=trace.log
```



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "colcon-lint",
    "maintainer": "Tatsuro Sakaguchi",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "tacchan.mello.ioiq@gmail.com",
    "keywords": "colcon",
    "author": "Tatsuro Sakaguchi",
    "author_email": "tacchan.mello.ioiq@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/6c/b7/2013c7f1118bbd6e3e584f644f6101742fa61652faecab3a2ec37857b7e8/colcon-lint-0.3.1.tar.gz",
    "platform": null,
    "description": "# colcon-lint\n\nColcon extension for linting ROS package dependencies.\n\nThis package is an extension of [colcon-core](https://github.com/colcon/colcon-core). Similar to [catkin-lint](https://github.com/fkie/catkin_lint) in ROS, it checks whether the dependencies of ROS2 packages are correctly described in the `package.xml`.\n\n## Installation\n\nTo use this extension, please execute the following:\n\n```bash\nsudo apt install apt-rdepends\npip install colcon-lint\n```\n\n## How to use\n\nPlease execute as follows. The package specification option is the same as other colcon commands.\n\n```bash\ncolcon lint --packages-select <package-name>\n```\n\nReplace `<package-name>` with the name of the package you want to check.\n\n### Options\n\n| Option | Description |\n| --- | --- |\n| package specification options | The same as other colcon commands. |\n| logging options | The same as other colcon commands. |\n| `--quick` | This option only checks for directly declared dependencies in the package.xml. It cannot detect dependencies that are resolved through recursively declared packages. |\n\n## Tips\n\nTo run faster, you can build with the `-Wno-dev --trace-expand --trace-redirect=trace.log` cmake option.\n\n```bash\ncolcon build --cmake-args -Wno-dev --trace-expand --trace-redirect=trace.log\n```\n\n\n",
    "bugtrack_url": null,
    "license": "Apache License, Version 2.0",
    "summary": "Colcon extension for linting ROS package dependencies",
    "version": "0.3.1",
    "project_urls": {
        "GitHub": "https://github.com/Tacha-S/colcon-lint/"
    },
    "split_keywords": [
        "colcon"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6cb72013c7f1118bbd6e3e584f644f6101742fa61652faecab3a2ec37857b7e8",
                "md5": "027b14b369b299722f9b2774cd2e5934",
                "sha256": "cb57332148dbce03206b400cd09ef09749ef73718b043a25c0dce14d7ebe4707"
            },
            "downloads": -1,
            "filename": "colcon-lint-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "027b14b369b299722f9b2774cd2e5934",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 11376,
            "upload_time": "2024-06-22T00:23:31",
            "upload_time_iso_8601": "2024-06-22T00:23:31.562952Z",
            "url": "https://files.pythonhosted.org/packages/6c/b7/2013c7f1118bbd6e3e584f644f6101742fa61652faecab3a2ec37857b7e8/colcon-lint-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-22 00:23:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Tacha-S",
    "github_project": "colcon-lint",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "colcon-lint"
}