Pyng: Matrix pager

Description

Matrix Pager is able to send alerts and notifications to Matrix rooms.

Matrix Pager requires curl command to be present in $PATH.

Options

Matrix Pager supports following options, which may be used upon creation of a new pager object:

url

Matrix client v3 URL (required)

token

Authentication token (required)

summary

Set to True to send shorter summaries, rather than longer messages

In addition, Matrix Pager supports following generic pager settings:

desc

Pager description

target

Default pager target, which is used as default recipient of pager messages in the pager's alert() and notify() methods

Example

pager = MatrixPager(
    url='https://matrix.org/_matrix/client/v3',
    token='...',
    target='!..................:matrix.domain.example',
)

# now you may use pager.alert() in the alert parameter in the checks,
# and pager.notify() in the notify paramter in the checks. alternatively,
# you may assign result of those methods to variables and use those in the
# checks

alerter = pager.alert()
notifier = pager.notify()

# alerter may be used in the alert parameter, and notifier in the notify parameter

# alert() and notify() methods will call send, with target
# given in alert() or notify(), or the default target given
# when creating the pager object

# calling send() may be used to test the pager
#pager.send('short summmary', 'longer message...')