This is a Secret Santa game CLI tool.
chore: readme updated
+7
-5
+5
-5
README.md
+5
-5
README.md
···
1
1
# Secret Santa CLI
2
2
3
-
This is a Secret Santa gane CLI tool. It takes a `.yaml` file to configure the game,
3
+
This is a Secret Santa game CLI tool. It takes a `.yaml` file to configure the game,
4
4
setting up the participants and the exclusions.
5
5
6
6
Then, uses [Mailgun API](https://documentation.mailgun.com/docs/mailgun/user-manual/get-started/)
···
48
48
49
49
```
50
50
# Mailgun configuration
51
-
SANTA_MAILGUN_API_URL=
52
-
SANTA_MAILGUN_API_KEY=
51
+
SANTA_MAILGUN_API_URL=https://api.eu.mailgun.net/v3/[your-domain]
52
+
SANTA_MAILGUN_API_KEY=[your-api-key]
53
53
```
54
54
55
55
## Usage
···
57
57
This package uses `uv` to handle the dependencies and virtual environment. The script
58
58
can be executed by running:
59
59
60
-
```bash
61
-
uv run secretsanta <config_yaml_file> [--dry]
60
+
```
61
+
uv run secretsanta <config_yaml_file> [--dry] [--seed string]
62
62
```
63
63
64
64
- `<config_yaml_file>`:
+2
src/secretsanta/cli.py
+2
src/secretsanta/cli.py
···
11
11
12
12
def app() -> None:
13
13
"""Main app function, entry point for the CLI, using argparse."""
14
+
14
15
# loads game config
15
16
parser = argparse.ArgumentParser(description="Secret Santa CLI tool.")
16
17
parser.add_argument(
···
34
35
if not config_file.is_file():
35
36
print("Game config file not found!")
36
37
sys.exit(1)
38
+
37
39
# creates the game
38
40
game = Game.create(config_file=config_file)
39
41
# runs the draw