Skip to main content

Use osascript to send notifications.

Project description

klaxon

Send Mac OS notifications from the terminal or Python programs.

This is useful for when you want a push notification for some long-running background task.

This is similar to the terminal-notifier ruby gem, but posix-compliant and with fewer features (PR's welcome).

Security Notice

DO NOT send untrusted input to through klaxon.

Someone could use a shell escape sequence to execute arbitrary code on your machine as klaxon functions by invoking osascript via a subprocess call.

You have been warned.

Usage

terminal

# blank notification
klaxon
# with custom message
klaxon --message "this is the message body"
# pipe message from other program
echo "this is the message body" | klaxon --

python

from klaxon import klaxon, klaxonify

# send a blank notification

klaxon()

# we can decorate our functions to have
# them send notifications at termination

@klaxonify
def hello(name='world'):
    return f'hello, {name}'

@klaxonify(title='oh hai', output_as_message=True)
def foo():
    return "This will be the message body."

Installation

For command-line use, the recommended method of installation is through pipx.

pipx install klaxon

Naturally, klaxon can also be pip-installed.

pip install klaxon

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

klaxon-0.1.4.tar.gz (6.9 kB view hashes)

Uploaded Source

Built Distribution

klaxon-0.1.4-py3-none-any.whl (16.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page