mirror of https://github.com/caronc/apprise
doc tidy-up and version inc
parent
a078558cc9
commit
ffec24e891
10
README
10
README
|
@ -1,7 +1,15 @@
|
||||||
ap·prise / verb
|
ap·prise / verb
|
||||||
To inform or tell (someone). To make one aware of something.
|
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
|
Supported Notifications
|
||||||
=======================
|
=======================
|
||||||
|
|
|
@ -6,15 +6,15 @@
|
||||||
To inform or tell (someone). To make one aware of something.
|
To inform or tell (someone). To make one aware of something.
|
||||||
<hr/>
|
<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.
|
* One notification library to rule them all.
|
||||||
* A common and intuitive notification syntax.
|
* A common and intuitive notification syntax.
|
||||||
* Supports the handling of images (to the notification services that will accept them).
|
* 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)
|
[![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)
|
[![CodeCov Status](https://codecov.io/github/caronc/apprise/branch/master/graph/badge.svg)](https://codecov.io/github/caronc/apprise)
|
||||||
|
|
|
@ -17,7 +17,7 @@
|
||||||
# GNU Lesser General Public License for more details.
|
# GNU Lesser General Public License for more details.
|
||||||
|
|
||||||
__title__ = 'apprise'
|
__title__ = 'apprise'
|
||||||
__version__ = '0.5.0'
|
__version__ = '0.5.1'
|
||||||
__author__ = 'Chris Caron <lead2gold@gmail.com>'
|
__author__ = 'Chris Caron <lead2gold@gmail.com>'
|
||||||
__license__ = 'GPLv3'
|
__license__ = 'GPLv3'
|
||||||
__copywrite__ = 'Copyright 2017-2018 Chris Caron <lead2gold@gmail.com>'
|
__copywrite__ = 'Copyright 2017-2018 Chris Caron <lead2gold@gmail.com>'
|
||||||
|
|
11
setup.py
11
setup.py
|
@ -18,6 +18,10 @@
|
||||||
|
|
||||||
import os
|
import os
|
||||||
import platform
|
import platform
|
||||||
|
import sys
|
||||||
|
from os.path import join
|
||||||
|
from os.path import abspath
|
||||||
|
from os.path import dirname
|
||||||
try:
|
try:
|
||||||
from setuptools import setup
|
from setuptools import setup
|
||||||
|
|
||||||
|
@ -26,6 +30,11 @@ except ImportError:
|
||||||
|
|
||||||
from setuptools import find_packages
|
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_options = os.environ.get("APPRISE_INSTALL", "").split(",")
|
||||||
install_requires = open('requirements.txt').readlines()
|
install_requires = open('requirements.txt').readlines()
|
||||||
if platform.system().lower().startswith('win'):
|
if platform.system().lower().startswith('win'):
|
||||||
|
@ -42,7 +51,7 @@ else:
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='apprise',
|
name='apprise',
|
||||||
version='0.5.0',
|
version=version,
|
||||||
description='A universal notification service',
|
description='A universal notification service',
|
||||||
license='GPLv3',
|
license='GPLv3',
|
||||||
long_description=open('README').read(),
|
long_description=open('README').read(),
|
||||||
|
|
Loading…
Reference in New Issue