20b743e2ab
* docs: update CONTRIBUTING pull request section * fixup! docs: update CONTRIBUTING pull request section |
||
|---|---|---|
| .github | ||
| assets | ||
| service | ||
| .codacy.yml | ||
| .editorconfig | ||
| .gitignore | ||
| .golangci.yml | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| Makefile | ||
| notifier.go | ||
| notify_test.go | ||
| notify.go | ||
| README.md | ||
| renovate.json | ||
| SECURITY.md | ||
| send_test.go | ||
| send.go | ||
| use_test.go | ||
| use.go | ||
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.
Since Notify is highly dependent on the consistency of the supported external services and the corresponding latest client libraries, we cannot guarantee its reliability nor its consistency, and therefore you should probably not use or rely on Notify in critical scenarios.
Install
go get -u github.com/nikoksr/notify
Example usage
// 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.
notify.UseServices(telegramService)
// Send a test message.
_ = notify.Send(
context.Background(),
"Subject/Title",
"The actual message - Hello, you awesome gophers! :)",
)
Recommendation
In this example, we use the global Send() function. Similar to most logging libraries such as
zap, we provide global functions for convenience. However, as with most logging
libraries, we also recommend avoiding the use of global functions as much as possible. Instead, use one of our versatile
constructor functions to create a new local Notify instance and pass it down the stream.
Read the library docs for more information.
Contributing
Yes, please! Contributions of all kinds are very welcome! Feel free to check our open issues. Please also take a look at the contribution guidelines.
Psst, don't forget to check the list of missing services waiting to be added by you or create a new issue if you want a new service to be added.
Supported services
Click here to request a missing service.
Special Thanks
Maintainers
Logo
The logo was made by the amazing MariaLetta.
Similar projects
Just to clarify, Notify was not inspired by any other project. I created it as a tiny subpackage of a larger project and only later decided to make it a standalone project. In this section I just want to mention other great projects.
Show your support
Give a ⭐️ if you like this project!