github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

doc tidy-up and version inc

pull/24/head
Chris Caron 2018-10-14 19:47:01 -04:00
parent a078558cc9
commit ffec24e891
4 changed files with 23 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README
View File

@ -1,7 +1,15 @@
ap·prise / verb
To inform or tell (someone). To make one aware of something.
Apprise allows you to take advantage of just about every notification service available to us today. Send a notification to almost all of the most popular services out there today (such as Telegram, Slack, Twitter, etc). The ones that don't exist can be adapted and supported too!
Apprise allows you to send a notification to *almost* all of the most popular notification services available to us today such as: Telegram, Pushbullet, Slack, Twitter, etc.
* One notification library to rule them all.
* A common and intuitive notification syntax.
* Supports the handling of images (to the notification services that will accept them).
System owners who wish to provide a notification service no longer need to research each and every new notification service as they come along. They just need to include this one library and then they can immediately gain access to a wide range of notifications services.
System Administrators who wish to send a notification from a scheduled task or from the command line also no longer need to find the right tool for the job. Everything is already wrapped and supported within the *apprise* script that ships with this product.
Supported Notifications
=======================

6
README.md
View File

@ -6,15 +6,15 @@
To inform or tell (someone). To make one aware of something.
<hr/>
*Apprise* allows you to send a notification to *almost* all of the most popular *notification* services out there today such as Telegram, Pushbullet, Slack, Twitter, etc. The idea of this library was to greatly simplify access to these notification services since all their APIs all drastically differ from one another.
*Apprise* allows you to send a notification to *almost* all of the most popular *notification* services available to us today such as: Telegram, Pushbullet, Slack, Twitter, etc.
* One notification library to rule them all.
* A common and intuitive notification syntax.
* Supports the handling of images (to the notification services that will accept them).
System owners who wish to provide a notification service no longer need to research each and every new notification service as they come along. They just need to include this one library and immediately gain access to a wide range of notifications services.
System owners who wish to provide a notification service no longer need to research each and every new notification service as they come along. They just need to include this one library and then they can immediately gain access to a wide range of notifications services.
System Administrators who wish to send a notification from a scheduled task or from the command line no longer need to find the right tool to the right notification service. Everything is already wrapped and supported within the *apprise* tool that ships with this product.
System Administrators who wish to send a notification from a scheduled task or from the command line also no longer need to find the right tool for the job. Everything is already wrapped and supported within the *apprise* script that ships with this product.
[![Build Status](https://travis-ci.org/caronc/apprise.svg?branch=master)](https://travis-ci.org/caronc/apprise)
[![CodeCov Status](https://codecov.io/github/caronc/apprise/branch/master/graph/badge.svg)](https://codecov.io/github/caronc/apprise)

2
apprise/__init__.py
View File

@ -17,7 +17,7 @@
# GNU Lesser General Public License for more details.
__title__ = 'apprise'
__version__ = '0.5.0'
__version__ = '0.5.1'
__author__ = 'Chris Caron <lead2gold@gmail.com>'
__license__ = 'GPLv3'
__copywrite__ = 'Copyright 2017-2018 Chris Caron <lead2gold@gmail.com>'

11
setup.py
View File

@ -18,6 +18,10 @@
import os
import platform
import sys
from os.path import join
from os.path import abspath
from os.path import dirname
try:
from setuptools import setup
@ -26,6 +30,11 @@ except ImportError:
from setuptools import find_packages
# Include 'this' library to allow a single location for
# version referencing
sys.path.insert(0, join(dirname(abspath(__file__)), 'apprise'))
from apprise import __version__ as version
install_options = os.environ.get("APPRISE_INSTALL", "").split(",")
install_requires = open('requirements.txt').readlines()
if platform.system().lower().startswith('win'):
@ -42,7 +51,7 @@ else:
setup(
name='apprise',
version='0.5.0',
version=version,
description='A universal notification service',
license='GPLv3',
long_description=open('README').read(),