Tirsvad
457b84c6da
README from the framework template, three terminal screenshots rendered by script, wiki pages in English, Danish and Bahasa Malaysia, the publish-wiki workflow, and the milestone links in the Project Plan. Refs #13 Refs #14 Refs #15 Refs #16 Refs #17 Refs #18
27 lines
953 B
Markdown
27 lines
953 B
Markdown
# Usage
|
|
|
|
🌐 **English** · [Dansk](Usage-da) · [Bahasa Melayu](Usage-ms)
|
|
|
|
Print the letters instead of sending them. `--today` pretends it is another day:
|
|
|
|
```bash
|
|
python -m birthday_wisher --dry-run --today 2000-10-17
|
|
```
|
|
|
|
|
|
|
|
Send the letters for today's birthdays (needs the [sender settings](Configuration)):
|
|
|
|
```bash
|
|
python -m birthday_wisher
|
|
```
|
|
|
|
| Option | Meaning |
|
|
| --- | --- |
|
|
| `--dry-run` | Print the e-mails instead of sending them |
|
|
| `--today YYYY-MM-DD` | Pretend today is this date |
|
|
| `--csv FILE` | Use another birthdays file |
|
|
| `--letters FOLDER` | Use another folder of letter templates |
|
|
|
|
Exit status 0 means success. Status 1 means the setup is wrong (missing file or setting) or a letter could not be sent. A birthday on 29 February is celebrated on 28 February in years that are not leap years.
|