mydomuk.pybell


Namemydomuk.pybell JSON
Version 0.0.25 PyPI version JSON
download
home_pageNone
SummaryPython Notification Tool
upload_time2024-10-03 13:09:57
maintainerNone
docs_urlNone
authorRichard Brent
requires_python>=3.7
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PyBell

PyBell is a multi service notification system written in Python.

The purpose behind this utility is to support sending push messages from a shell program
to indicate success or failure of an event to one or more notification systems.

For example if a Backup fails a push message can be sent to indicate failure.

The logic behind PyBell is that multiple services can be configured and whilst individual 
services can be selected by default the list of services will be chosen on a first work basis allowing 
for fallback to secondary services if the first etc do not work.

Because of the nature of this whilst the configuration file holds the connection details the command line
is very simple allowing for a message title, message and a priority to be used where supported.

PyBell currently supports the following services for basic message sending, this is easy to extend.

* Apprise
* Gotify
* PushBullet
* PushOver
* Telegram

For details of the required configuration once installed issue pybell -ch

## Apprise

Apprise is a sender of senders where other services can be configured and it will forward on.

It seems to lack the ability to send to 1 and if that fails then send to 2nd etc hence the evolution of this 
utility.

Priorities are not supported by the API of Apprise, but it can use priorities to forwarded services.

## Gotify

This is a self hosted solution allowing for messages to be sent from inside an environment without 
internet access

Priorities are available with this service, by default a priority of 6 is sent.

## PushBullet

An internet hosted platform supporting multiple facilities. 
This utility simply sends a broadcast push to all devices
I did look at using channels but these did not offer privacy at the time of writing so I did not explore
any further.

Priorities are not supported with this service.

## PushOver

An internet hosted platform dedicated to Push notifications.

Prioritoes are supported with this services, by default a priority of 0 is sent

## Telegram

An internet hosted chat service.
This utility can post to any chat which can be a dedicated 1-1 chat or a channel depending on the
chat identities supplied.

Priorities are not supported with this service.

## Example

pybell -t Test Message -m Hello World

This will send a notification with title of Test Message and message body of Hello World to the 1st defined 
entry in the pybell configuration file.

pybell -n ntfy -t Test Message -m Hello World

Will do the same as the previous example but just send to the config entry defined as ntfy



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mydomuk.pybell",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": "Richard Brent",
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "# PyBell\n\nPyBell is a multi service notification system written in Python.\n\nThe purpose behind this utility is to support sending push messages from a shell program\nto indicate success or failure of an event to one or more notification systems.\n\nFor example if a Backup fails a push message can be sent to indicate failure.\n\nThe logic behind PyBell is that multiple services can be configured and whilst individual \nservices can be selected by default the list of services will be chosen on a first work basis allowing \nfor fallback to secondary services if the first etc do not work.\n\nBecause of the nature of this whilst the configuration file holds the connection details the command line\nis very simple allowing for a message title, message and a priority to be used where supported.\n\nPyBell currently supports the following services for basic message sending, this is easy to extend.\n\n* Apprise\n* Gotify\n* PushBullet\n* PushOver\n* Telegram\n\nFor details of the required configuration once installed issue pybell -ch\n\n## Apprise\n\nApprise is a sender of senders where other services can be configured and it will forward on.\n\nIt seems to lack the ability to send to 1 and if that fails then send to 2nd etc hence the evolution of this \nutility.\n\nPriorities are not supported by the API of Apprise, but it can use priorities to forwarded services.\n\n## Gotify\n\nThis is a self hosted solution allowing for messages to be sent from inside an environment without \ninternet access\n\nPriorities are available with this service, by default a priority of 6 is sent.\n\n## PushBullet\n\nAn internet hosted platform supporting multiple facilities. \nThis utility simply sends a broadcast push to all devices\nI did look at using channels but these did not offer privacy at the time of writing so I did not explore\nany further.\n\nPriorities are not supported with this service.\n\n## PushOver\n\nAn internet hosted platform dedicated to Push notifications.\n\nPrioritoes are supported with this services, by default a priority of 0 is sent\n\n## Telegram\n\nAn internet hosted chat service.\nThis utility can post to any chat which can be a dedicated 1-1 chat or a channel depending on the\nchat identities supplied.\n\nPriorities are not supported with this service.\n\n## Example\n\npybell -t Test Message -m Hello World\n\nThis will send a notification with title of Test Message and message body of Hello World to the 1st defined \nentry in the pybell configuration file.\n\npybell -n ntfy -t Test Message -m Hello World\n\nWill do the same as the previous example but just send to the config entry defined as ntfy\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Python Notification Tool",
    "version": "0.0.25",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "df4dfb62550ef6fe3be23ab4b0baf28a5b79fef96cd643a305914fc97947de32",
                "md5": "ed13251651dc4f545c69c87e7ce964b8",
                "sha256": "5f1adef27ea9b0e6e82a8e7bc33a1a84f08e427b7357b83b377ed4188c6f5cdf"
            },
            "downloads": -1,
            "filename": "mydomuk.pybell-0.0.25-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ed13251651dc4f545c69c87e7ce964b8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 15660,
            "upload_time": "2024-10-03T13:09:57",
            "upload_time_iso_8601": "2024-10-03T13:09:57.086489Z",
            "url": "https://files.pythonhosted.org/packages/df/4d/fb62550ef6fe3be23ab4b0baf28a5b79fef96cd643a305914fc97947de32/mydomuk.pybell-0.0.25-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-03 13:09:57",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mydomuk.pybell"
}
        
Elapsed time: 2.94622s