mirror of
https://github.com/caronc/apprise.git
synced 2025-12-15 10:04:06 +08:00
bumped version to v1.9.1
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
.\" generated with Ronn-NG/v0.9.1
|
||||
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
||||
.TH "APPRISE" "1" "August 2024" "Chris Caron <lead2gold@gmail.com>"
|
||||
.TH "APPRISE" "1" "December 2024" "Chris Caron <lead2gold@gmail.com>"
|
||||
.SH "NAME"
|
||||
\fBapprise\fR \- Push Notifications that work with just about every platform!
|
||||
.SH "SYNOPSIS"
|
||||
@@ -108,6 +108,8 @@ The \fBstorage\fR action has the following sub actions:
|
||||
.IP "" 0
|
||||
.SH "SERVICE URLS"
|
||||
There are to many service URL and combinations to list here\. It\'s best to visit the Apprise GitHub page \fIhttps://github\.com/caronc/apprise/wiki#notification\-services\fR and see what\'s available\.
|
||||
.P
|
||||
The \fBenvironment variable\fR of \fBAPPRISE_URLS\fR (comma/space delimited) can be specified to provide the default set of URLs you wish to notify if none are otherwise specified\.
|
||||
.SH "EXAMPLES"
|
||||
Send a notification to as many servers as you want to specify as you can easily chain them together:
|
||||
.IP "" 4
|
||||
@@ -183,9 +185,13 @@ By default \fBapprise\fR looks in the following local locations for custom plugi
|
||||
.fi
|
||||
.IP "" 0
|
||||
.P
|
||||
Simply create your own python file with the following bare minimum content in it: from apprise\.decorators import notify
|
||||
The \fBenvironment variable\fR of \fBAPPRISE_PLUGIN_PATH\fR can be specified to override the list identified above with one of your own\. use a semi\-colon (\fB;\fR), line\-feed (\fB\en\fR), and/or carriage return (\fB\er\fR) to delimit multiple entries\.
|
||||
.P
|
||||
Simply create your own python file with the following bare minimum content in it:
|
||||
.IP "" 4
|
||||
.nf
|
||||
from apprise\.decorators import notify
|
||||
|
||||
# This example assumes you want your function to trigger on foobar://
|
||||
# references:
|
||||
@notify(on="foobar", name="My Custom Notification")
|
||||
@@ -223,6 +229,8 @@ Configuration files can be directly referenced via \fBapprise\fR when referencin
|
||||
.P
|
||||
The \fBconfiguration files\fR specified above can also be identified with a \fB\.yml\fR extension or even just entirely removing the \fB\.conf\fR extension altogether\.
|
||||
.P
|
||||
The \fBenvironment variable\fR of \fBAPPRISE_CONFIG_PATH\fR can be specified to override the list identified above with one of your own\. use a semi\-colon (\fB;\fR), line\-feed (\fB\en\fR), and/or carriage return (\fB\er\fR) to delimit multiple entries\.
|
||||
.P
|
||||
If a default configuration file is referenced in any way by the \fBapprise\fR tool, you no longer need to provide it a Service URL\. Usage of the \fBapprise\fR tool simplifies to:
|
||||
.IP "" 4
|
||||
.nf
|
||||
@@ -238,6 +246,14 @@ $ apprise \-vv \-\-title "Will Be Late Getting Home" \e
|
||||
\-\-tag=family
|
||||
.fi
|
||||
.IP "" 0
|
||||
.SH "ENVIRONMENT VARIABLES"
|
||||
\fBAPPRISE_URLS\fR: Specify the default URLs to notify IF none are otherwise specified on the command line explicitly\. If the \fB\-\-config\fR (\fB\-c\fR) is specified, then this will over\-rides any reference to this variable\. Use white space and/or a comma (\fB,\fR) to delimit multiple entries\.
|
||||
.P
|
||||
\fBAPPRISE_CONFIG_PATH\fR: Explicitly specify the config search path to use (over\-riding the default)\. Use a semi\-colon (\fB;\fR), line\-feed (\fB\en\fR), and/or carriage return (\fB\er\fR) to delimit multiple entries\.
|
||||
.P
|
||||
\fBAPPRISE_PLUGIN_PATH\fR: Explicitly specify the custom plugin search path to use (over\-riding the default)\. Use a semi\-colon (\fB;\fR), line\-feed (\fB\en\fR), and/or carriage return (\fB\er\fR) to delimit multiple entries\.
|
||||
.P
|
||||
\fBAPPRISE_STORAGE_PATH\fR: Explicitly specify the persistent storage path to use (over\-riding the default)\.
|
||||
.SH "BUGS"
|
||||
If you find any bugs, please make them known at: \fIhttps://github\.com/caronc/apprise/issues\fR
|
||||
.SH "DONATIONS"
|
||||
|
||||
@@ -63,6 +63,7 @@
|
||||
<a href="#EXAMPLES">EXAMPLES</a>
|
||||
<a href="#CUSTOM-PLUGIN-NOTIFICATIONS">CUSTOM PLUGIN/NOTIFICATIONS</a>
|
||||
<a href="#CONFIGURATION">CONFIGURATION</a>
|
||||
<a href="#ENVIRONMENT-VARIABLES">ENVIRONMENT VARIABLES</a>
|
||||
<a href="#BUGS">BUGS</a>
|
||||
<a href="#DONATIONS">DONATIONS</a>
|
||||
<a href="#COPYRIGHT">COPYRIGHT</a>
|
||||
@@ -246,6 +247,9 @@ loaded but none could be notified due to user filtering (via tags).</li>
|
||||
<p>There are to many service URL and combinations to list here. It's best to
|
||||
visit the <a href="https://github.com/caronc/apprise/wiki#notification-services">Apprise GitHub page</a> and see what's available.</p>
|
||||
|
||||
<p>The <strong>environment variable</strong> of <code>APPRISE_URLS</code> (comma/space delimited) can be specified to
|
||||
provide the default set of URLs you wish to notify if none are otherwise specified.</p>
|
||||
|
||||
<h2 id="EXAMPLES">EXAMPLES</h2>
|
||||
|
||||
<p>Send a notification to as many servers as you want to specify as you can
|
||||
@@ -311,11 +315,16 @@ files and loads them:</p>
|
||||
/var/lib/apprise/plugins
|
||||
</code></pre>
|
||||
|
||||
<p>Simply create your own python file with the following bare minimum content in
|
||||
it:
|
||||
from apprise.decorators import notify</p>
|
||||
<p>The <strong>environment variable</strong> of <code>APPRISE_PLUGIN_PATH</code> can be specified to override
|
||||
the list identified above with one of your own. use a semi-colon (<code>;</code>), line-feed (<code>\n</code>),
|
||||
and/or carriage return (<code>\r</code>) to delimit multiple entries.</p>
|
||||
|
||||
<pre><code># This example assumes you want your function to trigger on foobar://
|
||||
<p>Simply create your own python file with the following bare minimum content in
|
||||
it:</p>
|
||||
|
||||
<pre><code>from apprise.decorators import notify
|
||||
|
||||
# This example assumes you want your function to trigger on foobar://
|
||||
# references:
|
||||
@notify(on="foobar", name="My Custom Notification")
|
||||
def my_wrapper(body, title, notify_type, *args, **kwargs):
|
||||
@@ -361,6 +370,10 @@ in the following local locations for configuration files and loads them:</p>
|
||||
<p>The <strong>configuration files</strong> specified above can also be identified with a <code>.yml</code>
|
||||
extension or even just entirely removing the <code>.conf</code> extension altogether.</p>
|
||||
|
||||
<p>The <strong>environment variable</strong> of <code>APPRISE_CONFIG_PATH</code> can be specified to override
|
||||
the list identified above with one of your own. use a semi-colon (<code>;</code>), line-feed (<code>\n</code>),
|
||||
and/or carriage return (<code>\r</code>) to delimit multiple entries.</p>
|
||||
|
||||
<p>If a default configuration file is referenced in any way by the <strong>apprise</strong>
|
||||
tool, you no longer need to provide it a Service URL. Usage of the <strong>apprise</strong>
|
||||
tool simplifies to:</p>
|
||||
@@ -376,6 +389,23 @@ configuration that you want and only specifically notify a subset of them:</p>
|
||||
--tag=family
|
||||
</code></pre>
|
||||
|
||||
<h2 id="ENVIRONMENT-VARIABLES">ENVIRONMENT VARIABLES</h2>
|
||||
<p><code>APPRISE_URLS</code>:
|
||||
Specify the default URLs to notify IF none are otherwise specified on the command line
|
||||
explicitly. If the <code>--config</code> (<code>-c</code>) is specified, then this will over-rides any
|
||||
reference to this variable. Use white space and/or a comma (<code>,</code>) to delimit multiple entries.</p>
|
||||
|
||||
<p><code>APPRISE_CONFIG_PATH</code>:
|
||||
Explicitly specify the config search path to use (over-riding the default).
|
||||
Use a semi-colon (<code>;</code>), line-feed (<code>\n</code>), and/or carriage return (<code>\r</code>) to delimit multiple entries.</p>
|
||||
|
||||
<p><code>APPRISE_PLUGIN_PATH</code>:
|
||||
Explicitly specify the custom plugin search path to use (over-riding the default).
|
||||
Use a semi-colon (<code>;</code>), line-feed (<code>\n</code>), and/or carriage return (<code>\r</code>) to delimit multiple entries.</p>
|
||||
|
||||
<p><code>APPRISE_STORAGE_PATH</code>:
|
||||
Explicitly specify the persistent storage path to use (over-riding the default).</p>
|
||||
|
||||
<h2 id="BUGS">BUGS</h2>
|
||||
|
||||
<p>If you find any bugs, please make them known at:
|
||||
@@ -390,7 +420,7 @@ configuration that you want and only specifically notify a subset of them:</p>
|
||||
|
||||
<ol class='man-decor man-foot man foot'>
|
||||
<li class='tl'>Chris Caron <lead2gold@gmail.com></li>
|
||||
<li class='tc'>August 2024</li>
|
||||
<li class='tc'>December 2024</li>
|
||||
<li class='tr'>apprise(1)</li>
|
||||
</ol>
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ Telegram, Threema Gateway, Twilio, Twitter, Twist, VictorOps, Voipms, Vonage,
|
||||
WeCom Bot, WhatsApp, Webex Teams, Workflows, WxPusher, XBMC}
|
||||
|
||||
Name: python-%{pypi_name}
|
||||
Version: 1.9.0
|
||||
Version: 1.9.1
|
||||
Release: 1%{?dist}
|
||||
Summary: A simple wrapper to many popular notification services used today
|
||||
License: BSD
|
||||
@@ -149,6 +149,9 @@ LANG=C.UTF-8 PYTHONPATH=%{buildroot}%{python3_sitelib} py.test-%{python3_version
|
||||
%{python3_sitelib}/%{pypi_name}/cli.*
|
||||
|
||||
%changelog
|
||||
* Tue Dec 17 2024 Chris Caron <lead2gold@gmail.com> - 1.9.1
|
||||
- Updated to v1.9.1
|
||||
|
||||
* Mon Sep 2 2024 Chris Caron <lead2gold@gmail.com> - 1.9.0
|
||||
- Updated to v1.9.0
|
||||
|
||||
|
||||
Reference in New Issue
Block a user