mgdelacroix/birthdaybot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
44 commits 1 branch 0 tags 80 KiB
Go 97.3%
Nix 1.8%
Makefile 0.9%
Find a file
Miguel de la Cruz e6a59019c5 Reduce logger verbosity
2023-07-10 19:58:55 +02:00
cmd/birthdaybot Adds logger config 2023-07-10 14:55:47 +02:00
model Adds logger config 2023-07-10 14:55:47 +02:00
notification Move mocks to their own packages 2023-07-10 13:43:59 +02:00
parser Add a test for the CSV parser and check errors on the read config 2023-06-30 09:51:34 +02:00
server Reduce logger verbosity 2023-07-10 19:58:55 +02:00
.envrc Initial commit 2023-06-29 18:55:13 +02:00
.gitignore Adds initial implementation of the Telegram bot 2023-07-04 12:29:25 +02:00
.gitlab-ci.yml Adds go mock and generate make target and CI check 2023-07-10 12:29:25 +02:00
birthdays.csv Create a sample birthday.csv file 2023-06-30 11:38:03 +02:00
example-config.yml Adds logger config 2023-07-10 14:55:47 +02:00
go.mod Adds go mock and generate make target and CI check 2023-07-10 12:29:25 +02:00
go.sum Adds go mock and generate make target and CI check 2023-07-10 12:29:25 +02:00
Makefile Adds go mock and generate make target and CI check 2023-07-10 12:29:25 +02:00
README.md Reduce logger verbosity 2023-07-10 19:58:55 +02:00
shell.nix Adds go mock and generate make target and CI check 2023-07-10 12:29:25 +02:00

README.md

pipeline status

Birthday bot

A simple bot that notifies of birthdays, posting the contact information of the subject so you can reach them easily.

Configuration

There is an example configuration file that can be used as a base to create your own configuration, and there is a birthdays example CSV file to load the data.

Run the bot

To get help for the bot command, run:

$ ./birthdaybot -help
Usage of ./birthdaybot:
  -config string
        path to the configuration file (default "birthdaybot.yml")

To run the server with the development defaults, run:

$ make run

Roadmap

  • Create the bot scaffold
  • Define how to read the birthdays info
  • Add a logger instance to the config
  • Add config validation on server creation
  • Add options to the server
  • Pass logger to the server through an option
  • Configure logger through config (levels and such)
  • Reduce logger verbosity (through levels)
  • Create a configurable template to fill with each notification
  • Create different message systems to use with the bot
    • Telegram
    • Email
    • Mattermost
  • Enjoy!