extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2025-01-20 21:08:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated README to reference tagging and fixed typos

Browse Source
This commit is contained in:
Chris Caron 2019-03-05 19:40:36 -05:00
parent edf6d36c7d
commit 838370f441
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -140,7 +140,7 @@ apobj.notify(
```
### Configuration Files
Developers need access to configuration files too. The good news is they're use just involves declaring another object that Apprise can ingest as easy as the notification urls. You can mix and match config and notification entries too!
Developers need access to configuration files too. The good news is their use just involves declaring another object (called AppriseConfig) that Apprise can ingest too! You can mix and match config and notification entries too!
```python
import apprise
@ -148,7 +148,7 @@ import apprise
apobj = apprise.Apprise()
# Create an Config instance
config = apprise.AppriseCofig()
config = apprise.AppriseConfig()
# Add a configuration source:
config.add('/path/to/my/config.yml')
@ -160,14 +160,23 @@ config.add('https://myserver:8080/path/to/config')
apobj.add(config)
# You can mix and match; add an entry directly if you want too
apobj.add('mailto://myemail:mypass@gmail.com')
apobj.add('mailto://myemail:mypass@gmail.com', tag=admin)
# Then notify these services any time you desire. The below would
# notify all of the services loaded into our Apprise object.
# notify all of the services loaded into our Apprise object; this includes
# all items identified in the configuration files.
apobj.notify(
body='what a great notification service!',
title='my notification title',
)
# If you're using tagging, then you can load all of your notifications
# but only selectively call ones associated with one or more tags:
apobj.notify(
body='send a notification to our admin group'
title='Attention Admins',
tag='admin',
)
```
If you're interested in reading more about this and methods on how to customize your own notifications, please check out the wiki at https://github.com/caronc/apprise/wiki/Development_API