A utility for sending push notifications
ntfy brings notification to your shell. It can automatically provide desktop notifications when long running commands finish or it can send push notifications to your phone when a specific command finishes. Confused? This video demonstrates some of this functionality:
$ sudo pip install ntfy $ ntfy send test # send a notification when the command `sleep 10` finishes # this sends the message '"sleep 10" succeeded in 0:10 minutes' $ ntfy done sleep 10 $ ntfy -b pushover -o user_key t0k3n send 'Pushover test!' $ ntfy -t 'ntfy' send "Here's a custom notification title!" $ echo -e 'backends: ["pushover"]\npushover: {"user_key": "t0k3n"}' > ~/.ntfy.yml $ ntfy send "Pushover via config file!" $ ntfy done --pid 6379 # pid extra $ ntfy send ":tada: ntfy supports emoji! :100:" # emoji extra # Enable shell integration $ echo 'eval "$(ntfy shell-integration)"' >> ~/.bashrc
The install technique in the quickstart is the suggested method of installation. It can be installed in a virtualenv, but with some caveats: Linux notifications require --system-site-packages for the virtualenv and OS X notifications don’t work at all.
ntfy has support for automatically sending notifications when long running commands finish in bash and zsh. In bash it emulates zsh’s preexec and precmd functionality with rcaloras/bash-preexec. To enable it add the following to your .bashrc or .zshrc:
eval "$(ntfy shell-integration)"
By default it will only send notifications for commands lasting longer than 10 seconds and if the terminal is focused. Terminal focus works on X11(Linux) and with Terminal.app and iTerm2 on MacOS. Both options can be configured via the --longer-than and --foreground-too options.
To avoid unnecessary notifications when running interactive programs, programs listed in AUTO_NTFY_DONE_IGNORE don’t generate notifications. For example:
export AUTO_NTFY_DONE_IGNORE="vim screen meld"
To install multiple extras, separate with commas: e.g., ntfy[pid,emjoi].
ntfy is configured with a YAML file stored at ~/.ntfy.yml or in standard platform specific locations:
The backends key specifies what backends to use by default. Each backend has its own configuration, stored in a key of its own name. For example:
--- backends: - pushover pushover: user_key: hunter2 pushbullet: access_token: hunter2 simplepush: key: hunter2 slack: token: slacktoken recipient: "#slackchannel" xmpp: jid: "user@gmail.com" password: "xxxx" mtype: "chat" recipient: "me@jit.si"
If you want mulitple configs for the same backend type, you can specify any name and then specify the backend with a backend key. For example:
--- pushover: user_key: hunter2 cellphone: backend: pushover user_key: hunter2
See the backends below for available backends and options.
Requires extras, install like this: pip install ntfy[xmpp].
To verify the SSL certificates offered by a server: path_to_certs = “path/to/ca/cert”
Without dnspython library installed, you will need to specify the server hostname if it doesn’t match the jid.
For example, to use Google Talk you would need to use: hostname = ‘talk.google.com’
Specify port if other than 5222. NOTE: Ignored without specified hostname
Requires extras, install like this: pip install ntfy[telegram].
Requires ntfy to be installed as ntfy[telegram]. This backend is configured the first time you will try to use it: ntfy -b telegram send "Telegram configured for ntfy".
Requires extras, install like this: pip install ntfy[slack].
Requires extras, install like this pip install ntfy[instapush].
Instapush does not support notification title. It sends template-driven notifications, so you have to setup you events on the dashboard first. The backend is called insta due to homonymy with the instapush python wrapper
Note on trackers: Trackers are placeholders for events (a sort of notification template). If you defined more than one tracker in your event you’ll have to provide more messages. At the moment, the only way to do so is to separate each message with a colon (:) character. You can also escape the separator character: Example:
ntfy -b insta send "message1:message2" ntfy -b insta send "message1:message2\:with\:colons"
Works via dbus, works with most DEs like Gnome, KDE, XFCE and with libnotify.
The following dependecies should be installed.
$ sudo apt-get install libdbus-glib-1-dev libdbus-1-dev $ pip install --user dbus-python
You will need to install some font that supports emojis (in Debian fonts-symbola or Gentoo media-fonts/symbola).
Uses pywin32.
Requires ntfy to be installed globally (not in a virtualenv).
Uses the syslog core Python module, which is not available on Windows platforms.
prio - Syslog priority level. Default is ALERT. Possible values are:
facility - Syslog facility. Default is LOCAL5. Possible values are:
fmt - Format of the message to be sent to the system logger. The title and the message are specified using the following placeholders:
Default is [{title}] {message}.
Requires the app to be install from the Play store and the CLI utility be installed with apt install termux-api.
Title is configurable with the title key in the config. Example:
--- title: Customized Title
python setup.py test
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| File Name & Checksum SHA256 Checksum Help | Version | File Type | Upload Date |
|---|---|---|---|
| ntfy-2.4.4-py2.py3-none-any.whl (53.2 kB) Copy SHA256 Checksum SHA256 | py2.py3 | Wheel | Jun 5, 2017 |
