{"id":15296159,"url":"https://github.com/gazebosim/gz-utils","last_synced_at":"2025-12-12T01:04:48.633Z","repository":{"id":37068632,"uuid":"319481182","full_name":"gazebosim/gz-utils","owner":"gazebosim","description":"Classes and functions for robot applications","archived":false,"fork":false,"pushed_at":"2025-04-25T15:30:13.000Z","size":816,"stargazers_count":8,"open_issues_count":4,"forks_count":11,"subscribers_count":5,"default_branch":"gz-utils3","last_synced_at":"2025-04-25T15:41:21.790Z","etag":null,"topics":["cpp","cpp17","gazebo","gazebosim","hacktoberfest","ignition-gazebo","ignition-libraries","robotics","simulation","utilities-library"],"latest_commit_sha":null,"homepage":"https://gazebosim.org/","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gazebosim.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-12-08T00:32:44.000Z","updated_at":"2025-03-19T16:59:13.000Z","dependencies_parsed_at":"2024-03-04T20:41:10.141Z","dependency_job_id":"5b4fb2fe-8eeb-4961-9464-eac582ae4e8d","html_url":"https://github.com/gazebosim/gz-utils","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazebosim%2Fgz-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazebosim%2Fgz-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazebosim%2Fgz-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazebosim%2Fgz-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gazebosim","download_url":"https://codeload.github.com/gazebosim/gz-utils/tar.gz/refs/heads/gz-utils3","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252580132,"owners_count":21771269,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cpp","cpp17","gazebo","gazebosim","hacktoberfest","ignition-gazebo","ignition-libraries","robotics","simulation","utilities-library"],"created_at":"2024-09-30T18:09:36.304Z","updated_at":"2025-12-12T01:04:48.580Z","avatar_url":"https://github.com/gazebosim.png","language":"C++","readme":"# Gazebo Utils : Classes and functions for robot applications\n\n**Maintainer:** addisu AT openrobotics DOT org\n\n[![GitHub open issues](https://img.shields.io/github/issues-raw/gazebosim/gz-utils.svg)](https://github.com/gazebosim/gz-utils/issues)\n[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/gazebosim/gz-utils.svg)](https://github.com/gazebosim/gz-utils/pulls)\n[![Discourse topics](https://img.shields.io/discourse/https/community.gazebosim.org/topics.svg)](https://community.gazebosim.org)\n[![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://www.apache.org/licenses/LICENSE-2.0)\n\nBuild | Status\n-- | --\nTest coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-utils/branch/gz-utils3/graph/badge.svg)](https://app.codecov.io/gh/gazebosim/gz-utils/tree/gz-utils3)\nUbuntu Noble  | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_utils-ci-gz-utils3-noble-amd64)](https://build.osrfoundation.org/job/gz_utils-ci-gz-utils3-noble-amd64)\nHomebrew      | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_utils-ci-gz-utils3-homebrew-amd64)](https://build.osrfoundation.org/job/gz_utils-ci-gz-utils3-homebrew-amd64)\nWindows       | [![Build Status](https://build.osrfoundation.org/job/gz_utils-3-clowin/badge/icon)](https://build.osrfoundation.org/job/gz_utils-3-clowin/)\n\nGazebo Utils, a component of [Gazebo](https://gazebosim.org), provides general purpose\nclasses and functions designed for robotic applications.\n\n# Table of Contents\n\n[Features](#features)\n\n[Install](#install)\n\n[Usage](#usage)\n\n[Documentation](#documentation)\n\n[Testing](#testing)\n\n[Folder Structure](#folder-structure)\n\n[Code of Conduct](#code-of-conduct)\n\n[Contributing](#code-of-contributing)\n\n[Versioning](#versioning)\n\n[License](#license)\n\n# Features\n\nGazebo Utils provides a wide range of functionality, including:\n\n* A helper class to implement the PIMPL pattern\n* A command line parsing utility (vendored [CLI11](https://github.com/CLIUtils/CLI11/))\n* Macros to suppress warnings\n\n# Install\n\nSee the [installation tutorial](https://gazebosim.org/api/utils/2/install.html).\n\n# Usage\n\nPlease refer to the [examples directory](https://github.com/gazebosim/gz-utils/blob/gz-utils3/examples/).\n\n# Documentation\n\nAPI and tutorials can be found at [https://gazebosim.org/libs/utils](https://gazebosim.org/libs/utils).\n\nYou can also generate the documentation from a clone of this repository by following these steps.\n\n1. You will need Doxygen. On Ubuntu Doxygen can be installed using\n\n    ```\n    sudo apt-get install doxygen\n    ```\n\n2. Clone the repository\n\n    ```\n    git clone https://github.com/gazebosim/gz-utils\n    ```\n\n3. Configure and build the documentation.\n\n    ```\n    cd gz-utils; mkdir build; cd build; cmake ../; make doc\n    ```\n\n4. View the documentation by running the following command from the build directory.\n\n    ```\n    firefox doxygen/html/index.html\n    ```\n\n# Testing\n\nFollow these steps to run tests and static code analysis in your clone of this repository.\n\n1. Follow the [source install instruction](https://gazebosim.org/api/utils/2/install.html#source-install).\n\n2. Run tests.\n\n    ```\n    make test\n    ```\n\n3. Static code checker.\n\n    ```\n    make codecheck\n    ```\n\n# Folder Structure\n\nRefer to the following table for information about important directories and files in this repository.\n\n```\ngz-utils\n├── cli                      Gazebo CLI component. Vendored from https://github.com/CLIUtils/CLI11/\n├── examples                 Example programs.\n├── include/gz/utils         Header files.\n├── src                      Source files and unit tests.\n├── test\n│    ├── integration         Integration tests.\n│    ├── performance         Performance tests.\n│    └── regression          Regression tests.\n├── tutorials                Tutorials, written in markdown.\n├── Changelog.md             Changelog.\n└── CMakeLists.txt           CMake build script.\n```\n# Contributing\n\nPlease see\n[CONTRIBUTING.md](https://gazebosim.org/docs/all/contributing).\n\n# Code of Conduct\n\nPlease see\n[CODE_OF_CONDUCT.md](https://github.com/gazebosim/gz-utils/blob/main/CODE_OF_CONDUCT.md)\n\n# Versioning\n\nThis library uses [Semantic Versioning](https://semver.org/).\nAdditionally, this library is part of the\n[Gazebo project](https://gazebosim.org) which periodically\nreleases a versioned set of compatible and complimentary libraries. See the\n[Gazebo website](https://gazebosim.org) for version and\nrelease information.\n\n# License\n\nThis library is licensed under\n[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).\nSee also the\n[LICENSE](https://github.com/gazebosim/gz-utils/blob/main/LICENSE)\nfile.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgazebosim%2Fgz-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgazebosim%2Fgz-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgazebosim%2Fgz-utils/lists"}