bdaiinstitute / spot_ros2 / 8251513234

52%

push

github

[SW-764] Consolidate examples into a single ROS package (#279)

## Change Overview

This PR puts all spot related examples in `spot_ros2` into a single package called `spot_examples`. Previously, all examples of using the Spot driver were organized into separate ROS packages in the `examples` directory.  Each of these ROS 2 packages only held a single node, resulting in a lot of bloat and making it more of a hassle to add new examples.

Old structure:
```
examples/
├── README.md
├── inverse_kinematics_example (ROS2 package)
│   ├── inverse_kinematics_example
│   │   └── send_inverse_kinematics_requests.py
│   ├── package.xml
│   ├── README.md
│   ├──  ...
├── simple_arm_motion (ROS2 package)
│   ├── ...
├── simple_walk_forward (ROS2 package)
│   ├── ...
├── utilities (ROS2 package)
│   ├── ...


```

New file structure implemented in this PR
```
├── spot_examples (ROS 2 package)
│   └── spot_examples
│       ├── __init__.py
│       ├── arm_simple.py
│       ├── send_inverse_kinematics_requests.py
│       ├── simple_spot_commander.py
│       └── walk_forward.py
│   ├── docs
│   │   ├── arm_simple.md
│   │   ├── send_inverse_kinematics_requests.md
│   │   └── walk_forward.md
│   ├── package.xml
│   ├── setup.py
│   ├── README.md
│   ├── ...

```

Now, when a new example is added, instead of creating an entirely new package, these steps can be followed. 
* create `new_example.py` in `spot_examples/spot_examples` and add it to `spot_examples/setup.py`
* add documentation `new_example.md` to `spot_examples/docs` and link to it in `spot_examples/README.md`

## Additional consideration
In our internal repo, there is a single file that uses `SimpleSpotCommander` which used to be in `examples/utilities` ROS 2 package (can be found by searching for the string
`from utilities.simple_spot_commander import SimpleSpotCommander`). This would now need to be updated to `from spot_examples.simple_spot_commander import SimpleSpotCommander` with this implementation. 

##... (continued)

200 of 495 branches covered (40.4%)

Branch coverage included in aggregate %.

2274 of 4885 relevant lines covered (46.55%)

2.29 hits per line