workshop-runner 0.2.0

A CLI to run test-driven Rust workshops
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

<h1 align="center">wr</h1>
<div align="center">
 <strong>
   A Rust workshop runner
 </strong>
</div>

<br />

![demo](demo.gif)

`wr` is a CLI to drive test-driven workshops written in Rust.  
It is designed to be used in conjunction with a workshop repository, which contains a series of exercises to be solved
by the workshop participants.

> [!NOTE] 
> This workshop runner has been developed by [Mainmatter](https://mainmatter.com/rust-consulting/) to support our [hands-on Rust workshops](https://mainmatter.com/services/workshops/rust/).
> Check out our [landing page](https://mainmatter.com/rust-consulting/) if you're looking for Rust consulting or training!

## How it works

> What I cannot create, I do not understand.
>
> Richard Feynman

A test-driven workshop is structured as a series of exercises.  
Each exercise is a Rust project with a set of tests that verify the correctness of the solution.  

`wr` will run the tests for the current exercise and, if they pass, allow you to move on to the next exercise while
keeping track of what you have solved so far.

You can see it in action in the [rust-telemetry-workshop](https://github.com/mainmatter/rust-telemetry-workshop).

## Installation

```bash
cargo install workshop-runner
```

Check that it has been installed correctly:

```bash
wr --help
```

Run

```bash
wr
```
from the top-level folder of a workshop repository to verify your current solutions and move forward in the workshop.

Enjoy!

## Folder structure

`wr` expects the following structure for the workshop repository:

```
.
├── exercises
│  ├── 00_<collection name>
│  │  ├── 00_<exercise name>
│  │  │  ..
│  │  ├── 0n_<exercise name>
│  │  ..
│  ├── 0n_<collection name>
│  │  ├── 00_<exercise name>
│  │  │  ..
│  │  ├── 0n_<exercise name>
```

Each `xx_<exercise name>` folder must be a Rust project with its own `Cargo.toml` file.

You can choose a different top-level folder name by either passing the `--exercises-dir` flag when invoking `wr` 
or by creating a top-level `wr.toml` file with the following content:

```toml
exercises-dir = "my-top-level-folder"
```

You can refer to [rust-telemetry-workshop](https://github.com/mainmatter/rust-telemetry-workshop) as an example.