Pushit

Send Pushover notifications.

Install

Pushit needs Python 3.13 or later, a Pushover user key, and an application API token.

pip install lupaxa-pushit
pushit --help

CLI

pushit --user "$PUSHOVER_USER_KEY" --token "$PUSHOVER_API_TOKEN" --text "Hello"
pushit --profile alerts --text "Hello"
pushit -p alerts --config "$HOME/work/pushit.yml" --text "Disk full"
pushit --profile alerts --text "down" --emergency --group "$PUSHOVER_GROUP_KEY"
pushit --profile alerts --text "see" --title pushit --url https://example.com --url-title Open
pushit --profile alerts --text "see" --attachment report.png --sound pushover --device phone
pushit --token "$PUSHOVER_API_TOKEN" --sounds
python -m lupaxa.pushit --version

--text is required for a send. --emergency and --group may be combined with it. --priority cannot be combined with --emergency. --retry and --expire require --emergency. --sounds lists sorted sound names, one per line, and cannot be combined with a send.

A successful send prints nothing. The $PUSHOVER_* names are shell variables expanded before pushit runs. Pushit does not read environment variables. A command-line value overrides the same profile field. --group replaces the user key for that send. Error text replaces the API token, user key, and group key with [redacted].

Config

Profiles live in $HOME/.pushit.yml. Pass --config to use another file. --config requires --profile. url_title requires a url. retry and expire are used only for an emergency send. There is no profile field for a group key.

profiles:
  alerts:
    user_key: USER_KEY
    api_token: API_TOKEN
    title: pushit
    url: https://example.com/alert
    url_title: Open
    sound: pushover
    device: phone
    priority: 0
    timeout: 15
    retry: 30
    expire: 3600

Library

from lupaxa.pushit import Pushit, load_profile

profile = load_profile("alerts")
client = Pushit(
    profile.api_token,
    user_key=profile.user_key,
    timeout=profile.timeout or 10.0,
)
body = client.send_message(
    "disk full",
    title="pushit",
    priority=2,
    retry=30,
    expire=3600,
    group_key="GROUP_KEY",
)
client.list_sounds()

send_message and list_sounds return the parsed JSON object. load_profile reads one named profile. The package also exports ConfigError, Profile, default_config_path, DEFAULT_TIMEOUT, get_version, and __version__.

Reference

Development

make init
make python-install-dev
make python-check