go/notify
1
0
Fork 0
mirror of https://github.com/nikoksr/notify.git synced 2024-11-24 08:22:18 +02:00
Code Issues Releases Activity
A dead simple Go library for sending notifications to various messaging services.
171 Commits 1 Branch 60 Tags 8.4 MiB
Go 99.1%
Makefile 0.9%
dbf6bf12f1
Go to file
Sebastian Spaink dbf6bf12f1 Minor update for slack usage doc
2021-03-01 20:33:42 -06:00
.github Merge branch 'main' into dependabot/github_actions/actions/cache-v2.1.4 2021-02-08 23:05:16 +01:00
assets docs(readme): refactor readme 2021-01-26 10:45:14 +01:00
service Minor update for slack usage doc 2021-03-01 20:33:42 -06:00
.codacy.yml build(lint): make codacy ignore markdown files 2021-01-31 02:08:05 +01:00
.editorconfig feat: init project 2021-01-25 00:14:21 +01:00
.gitignore feat: init project 2021-01-25 00:14:21 +01:00
.golangci.yml feat: init project 2021-01-25 00:14:21 +01:00
.kodiak.toml build(kodiak): remove deprecated config option 2021-01-31 15:03:56 +01:00
CODE_OF_CONDUCT.md docs: add readme, coc, and contrib guidelines 2021-01-25 05:05:59 +01:00
CONTRIBUTING.md docs(contrib): update contribution guidelines 2021-01-31 15:02:45 +01:00
go.mod build(deps): bump github.com/mailgun/mailgun-go/v4 from 4.3.4 to 4.4.1 2021-02-24 08:05:25 +00:00
go.sum build(deps): bump github.com/mailgun/mailgun-go/v4 from 4.3.4 to 4.4.1 2021-02-24 08:05:25 +00:00
LICENSE feat: init project 2021-01-25 00:14:21 +01:00
Makefile build(make): Add make file and go-generate directives 2021-01-31 14:56:06 +01:00
notifier.go refactor(send): Add context.Context to parameter list of Send method 2021-02-18 03:33:30 +01:00
notify.go chore(comment): add punctuation to function comment 2021-02-10 14:49:25 +01:00
README.md refactor(send): Add context.Context to parameter list of Send method 2021-02-18 03:33:30 +01:00
send.go refactor(send): Add context.Context to parameter list of Send method 2021-02-18 03:33:30 +01:00
use.go refactor(use): simplify useService function 2021-02-10 14:52:09 +01:00

README.md

notify logo

GitHub tag (latest SemVer) Go Report Card Codacy Badge Maintainability FOSSA Status go.dev reference

A dead simple Go library for sending notifications to various messaging services.

About

Notify was born out of my own need to have my API servers running in production be able to notify me when critical errors occur. Of course, Notify can be used for any other purpose as well. The library is kept as simple as possible for quick integration and ease of use.

Disclaimer

Any misuse of this library is your own liability and responsibility and cannot be attributed to the authors of this library. See license for more.

Spamming through the use of this library may get you permanently banned on most supported platforms.

Install 

go get -u github.com/nikoksr/notify

Example usage 

// Create our notifications distributor.
notifier := notify.New()

// Create a telegram service. Ignoring error for demo simplicity.
telegramService, _ := telegram.New("your_telegram_api_token")

// Passing a telegram chat id as receiver for our messages.
// Basically where should our message be sent?
telegramService.AddReceivers(-1234567890)

// Tell our notifier to use the telegram service. You can repeat the above process
// for as many services as you like and just tell the notifier to use them.
// Inspired by http middlewares used in higher level libraries.
notifier.UseServices(telegramService)

// Send a test message.
_ = notifier.Send(
	context.Background(),
	"Subject/Title",
	"The actual message - Hello, you awesome gophers! :)",
)

Supported services

Please create feature requests for missing services (see #3 for example)

  • Amazon SES
  • Discord
  • Email
  • Mailgun
  • Microsoft Teams
  • Plivo
  • Pushbullet
  • SendGrid
  • Slack
  • Telegram
  • Twitter
  • WhatsApp

Credits

Author

Niko Köser

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if you like this project!

License

FOSSA Status