See changelog for recent changes
Got an app or service and you want to enable your users to use notifications with their provider of choice? Working on a script and you want to receive notification based on its output? You don't need to implement a solution yourself, or use individual provider libs. A one stop shop for all notification providers with a unified and simple interface.
Supported providers
Pushover, SimplePush, Slack, Gmail, Email (SMTP), Telegram, Gitter, Pushbullet, Join, Hipchat, Zulip, Twilio, Pagerduty, Mailgun, PopcornNotify, StatusPage.io
Advantages
- Spend your precious time on your own code base, instead of chasing down 3rd party provider APIs. That's what we're here for!
- With a minimal set of well known and stable dependencies (requests, jsonschema and click) you're better off than installing 3rd party SDKs.
- A unified interface means that you already support any new providers that will be added, no more work needed!
- Thorough testing means protection against any breaking API changes. We make sure your code your notifications will always get delivered!
Installation
Via pip:
$ pip install notifiers
Via homebrew:
$ brew install notifiers
Or Dockerhub:
$ docker pull liiight/notifiers
Basic Usage
>>> from notifiers import get_notifier
>>> p = get_notifier('pushover')
>>> p.required
{'required': ['user', 'message', 'token']}
>>> p.notify(user='foo', token='bar', message='test')
<NotificationResponse,provider=Pushover,status=Success>
Or:
>>> from notifiers import notify
>>> notify('pushover', user='foo', token='bar', message='test')
<NotificationResponse,provider=Pushover,status=Success>
From CLI
$ notifiers pushover notify --user foo --token baz "This is so easy!"
As a logger
Directly add to your existing stdlib logging:
>>> import logging
>>> from notifiers.logging import NotificationHandler
>>> log = logging.getLogger(__name__)
>>> defaults = {
'token': 'foo',
'user': 'bar'
}
>>> hdlr = NotificationHandler('pushover', defaults=defaults)
>>> hdlr.setLevel(logging.ERROR)
>>> log.addHandler(hdlr)
>>> log.error('And just like that, you get notified about all your errors!')
Mentions
- Mentioned in Python Bytes podcast
Road map
- Many more providers!
- Low level providers (Amazon SNS, Google FCM, OS Toast messages) via
extradependencies
See Docs for more information
Donations
If you like this and want to buy me a cup of coffee, please click the donation button above or click this link
Code of Conduct
Everyone interacting in the Notifiers project's codebases, issue trackers and chat rooms is expected to follow the PyPA Code of Conduct.
![[pre-commit.ci] pre-commit autoupdate](https://avatars.githubusercontent.com/in/68672?v=4)
2k Dec 26, 2022
6 Aug 5, 2022
9 Nov 3, 2022
1 Nov 15, 2021
1 Jan 11, 2022
1 Jan 14, 2022
10 Dec 10, 2022
9 Nov 14, 2022
2 Apr 25, 2022
6 Nov 27, 2022
5 Oct 5, 2022
1 Nov 15, 2021
1 Nov 30, 2021
0 Aug 9, 2022
14 Jun 29, 2022
25 Aug 16, 2022
368 Jan 4, 2023
7 Nov 24, 2022
10 Jun 30, 2021
293 Jan 7, 2023