2023-06-30 08:59:17 +01:00
|
|
|
[](https://gitlab.ctrlz.es/mgdelacroix/birthdaybot/-/commits/main)
|
|
|
|
|
|
2023-06-29 17:55:13 +01:00
|
|
|
# Birthday bot
|
|
|
|
|
|
|
|
|
|
A simple bot that notifies of birthdays, posting the contact
|
|
|
|
|
information of the subject so you can reach them easily.
|
|
|
|
|
|
2023-06-30 09:42:27 +01:00
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
There is an [example configuration file](./example-config.yml) that
|
2023-06-30 10:39:13 +01:00
|
|
|
can be used as a base to create your own configuration, and there is a
|
|
|
|
|
[birthdays example CSV file](./birthdays.csv) to load the data.
|
2023-06-30 09:42:27 +01:00
|
|
|
|
2023-07-01 16:33:30 +01:00
|
|
|
## Run the bot
|
|
|
|
|
|
|
|
|
|
To get help for the bot command, run:
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
$ ./birthdaybot -help
|
|
|
|
|
Usage of ./birthdaybot:
|
|
|
|
|
-config string
|
|
|
|
|
path to the configuration file (default "birthdaybot.yml")
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To run the server with the development defaults, run:
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
$ make run
|
|
|
|
|
```
|
|
|
|
|
|
2023-06-29 17:55:13 +01:00
|
|
|
## Roadmap
|
|
|
|
|
|
2023-07-01 16:31:09 +01:00
|
|
|
- [X] Create the bot scaffold
|
2023-06-30 08:58:21 +01:00
|
|
|
- [X] Define how to read the birthdays info
|
2023-06-30 09:38:29 +01:00
|
|
|
- [X] Add a logger instance to the config
|
2023-06-30 09:33:25 +01:00
|
|
|
- [ ] Add config validation on server creation
|
2023-07-02 09:00:28 +01:00
|
|
|
- [ ] Add options to the server
|
|
|
|
|
- [ ] Pass logger to the server through an option
|
2023-06-29 17:55:13 +01:00
|
|
|
- [ ] Create a configurable template to fill with each notification
|
|
|
|
|
- [ ] Create different message systems to use with the bot
|
2023-07-04 11:29:13 +01:00
|
|
|
- [X] Telegram
|
|
|
|
|
- [ ] Email
|
|
|
|
|
- [ ] Mattermost
|
2023-07-01 16:31:09 +01:00
|
|
|
- [ ] Reduce logger verbosity
|
2023-06-29 17:55:13 +01:00
|
|
|
- [ ] Enjoy!
|
