Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liiight/notifiers
The easy way to send notifications
https://github.com/liiight/notifiers
notification-service notifications notifier pypi python python3
Last synced: 3 days ago
JSON representation
The easy way to send notifications
- Host: GitHub
- URL: https://github.com/liiight/notifiers
- Owner: liiight
- License: mit
- Created: 2017-06-01T10:20:18.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T11:22:00.000Z (7 months ago)
- Last Synced: 2024-05-19T07:27:38.064Z (7 months ago)
- Topics: notification-service, notifications, notifier, pypi, python, python3
- Language: Python
- Homepage: http://notifiers.readthedocs.io/
- Size: 936 KB
- Stars: 2,605
- Watchers: 30
- Forks: 106
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT
Awesome Lists containing this project
- awesomeLibrary - notifiers - The easy way to send notifications (语言资源库 / python)
- my-awesome-github-stars - liiight/notifiers - The easy way to send notifications (Python)
- best-of-python-dev - GitHub - 42% open · ⏱️ 01.05.2024): (Logging)
- jimsghstars - liiight/notifiers - The easy way to send notifications (Python)
README
[](https://actions-badge.atrox.dev/notifiers/notifiers/goto?ref=master) [ ](https://codecov.io/gh/notifiers/notifiers) [ ](https://gitter.im/notifiers/notifiers) [ ](https://pypi.python.org/pypi/notifiers) [ ](https://pypi.org/project/notifiers) [ ](https://choosealicense.com/licenses) [ ](https://pypi.org/project/notifiers/) [ ](https://hub.docker.com/r/liiight/notifiers/) [ ](https://readthedocs.org/projects/notifiers/badge/?version=latest) [ ](https://paypal.me/notifiers) [](http://pepy.tech/count/notifiers)
[](https://twitter.com/liiight) [](https://github.com/ambv/black) [](https://github.com/pre-commit/pre-commit)
See [changelog](http://notifiers.readthedocs.io/en/latest/changelog.html) 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](https://pushover.net/), [SimplePush](https://simplepush.io/), [Slack](https://api.slack.com/), [Gmail](https://www.google.com/gmail/about/), Email (SMTP), [Telegram](https://telegram.org/), [Gitter](https://gitter.im), [Pushbullet](https://www.pushbullet.com), [Join](https://joaoapps.com/join/), [Zulip](https://zulipchat.com/), [Twilio](https://www.twilio.com/), [Pagerduty](https://www.pagerduty.com), [Mailgun](https://www.mailgun.com/), [PopcornNotify](https://popcornnotify.com), [StatusPage.io](https://statuspage.io), [iCloud](https://www.icloud.com/mail), [VictorOps (Splunk)](https://www.splunk.com/en_us/investor-relations/acquisitions/splunk-on-call.html), [Notify](https://github.com/K0IN/Notify)
# 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](https://pypi.python.org/pypi/requests), [jsonschema](https://pypi.python.org/pypi/jsonschema/2.6.0) and [click](https://pypi.python.org/pypi/click/6.7)) 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
```python
>>> from notifiers import get_notifier
>>> p = get_notifier('pushover')
>>> p.required
{'required': ['user', 'message', 'token']}
>>> p.notify(user='foo', token='bar', message='test')
```
Or:
```python
>>> from notifiers import notify
>>> notify('pushover', user='foo', token='bar', message='test')
```
# From CLI
```text
$ notifiers pushover notify --user foo --token baz "This is so easy!"
```
# As a logger
Directly add to your existing stdlib logging:
```python
>>> 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](https://pythonbytes.fm/episodes/show/67/result-of-moving-python-to-github) podcast
# Road map
- Many more providers!
- Low level providers (Amazon SNS, Google FCM, OS Toast messages) via `extra` dependencies
See [Docs](http://notifiers.readthedocs.io/) 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](https://paypal.me/notifiers) ☕
# 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.](https://www.pypa.io/en/latest/code-of-conduct/)