# The Artefacts Toolkit (beta)

> Using the Artefacts Toolkit

---

Site [llms.txt](/llms.txt)

---

> [!NB] _The Artefacts Toolkit is under constant development, improving and adding new features. Please check back often!_

The Artefacts Toolkit is a Python package designed to improve developer productivity. It provides a collection of helper functions that simplify common testing tasks and integrate with the Artefacts platform.

The toolkit is organized into the following modules:

* [Configuration Helpers](/artefacts-toolkit/config) - Simplify parametric testing and bring in configurations from the `artefacts.yaml` file
* [Chart Helpers](/artefacts-toolkit/charts) - Generate visualisations from test data
* [Gazebo Helpers](/artefacts-toolkit/gazebo) - Interact with Gazebo simulations during tests
* [Rosbag Helpers](/artefacts-toolkit/rosbag) - Record, extract, and analyze data from ROS bag files
* [Rerun Helpers](/artefacts-toolkit/rerun) - Record Rerun `.rrd` files during simulation and make test assertions against them
* [Navigation Helpers](/artefacts-toolkit/navigation) - Record a route in RViz, spawn the robot at its start, drive it through Nav2 and assert on the result

## Installation

```bash
pip install artefacts-toolkit
```

> [!NOTE]
> The Artefacts Toolkit is designed to be used together with the Artefacts CLI, `artefacts.yaml`, and the Artefacts Dashboard. Some functions may work without it, but cannot be guaranteed.

## Example Projects using the Artefacts Toolkit:

* <a href="https://github.com/art-e-fact/navigation2_ignition_gazebo_example/tree/main" target="_blank">Nav2</a> - An example project using the Nav2 navigation stack and Gazebo.

---

Section pages:

- [Configuration Helpers in the Artefacts Toolkit](/artefacts-toolkit/config/)
- [Chart Helpers in the Artefacts Toolkit](/artefacts-toolkit/charts/)
- [Gazebo Helpers in the Artefacts Toolkit](/artefacts-toolkit/gazebo/)
- [Rosbag Helpers in the Artefacts Toolkit](/artefacts-toolkit/rosbag/)
- [Rerun Helpers in the Artefacts Toolkit](/artefacts-toolkit/rerun/)
- [Navigation Helpers in the Artefacts Toolkit](/artefacts-toolkit/navigation/)
