Repository Summary
Checkout URI | https://github.com/clearpathrobotics/clearpath_config.git |
VCS Type | git |
VCS Version | main |
Last Updated | 2024-09-29 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
clearpath_config | 0.3.3 |
README
clearpath_config
Clearpath Configuration YAML Parser
Find documentation on the Clearpath Configuration YAML and more about the Clearpath ROS 2 System on the Clearpath Documentation webpage.
Configration Examples
Under the sample folder there are example configurations that can be used as the starting point of your robot.yaml
.
Unit Tests
All unit tests are written using PyTest following the Good Integration Practices.
Therefore, clearpath_config_test
is a package that mirrors the clearpath_config
package structure. Each file from clearpath_config
that is to be tested should have a corresponding file with the same name and the suffix _test.py
.
To run the tests:
cd .../clearpath_config
python3 -m pytest
PyTest will automatically search for the suffix
_test
throughout the current directory and run the tests.
CONTRIBUTING
No CONTRIBUTING.md found.
No version for distro iron. Known supported distros are highlighted in the buttons above.
No version for distro jazzy. Known supported distros are highlighted in the buttons above.
No version for distro rolling. Known supported distros are highlighted in the buttons above.
No version for distro noetic. Known supported distros are highlighted in the buttons above.
No version for distro galactic. Known supported distros are highlighted in the buttons above.
No version for distro melodic. Known supported distros are highlighted in the buttons above.