Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

A utility for sending push notifications

Project description

About ntfy

Version Downloads Build Coverage

ntfy is a command line utility (and to a degree, python library) for sending push notifications. It also can send a notification when a program finishes.

Unlike many existing utilities for Pushover or Pushbullet, it supports multiple backends.

Demo

https://raw.githubusercontent.com/dschep/ntfy/master/demo.gif

Install

sudo pip install ntfy

Note: It is suggested to globally (as indicated above, without a virtualenv) install ntfy. It can be installed in a virtualenv, with caveats. Linux notifications requires --system-site-packages to be used and OS X notifications don’t work at all.

Usage

# send a notification
ntfy send "Here's a notification!"

# send a notification with custom title (default is $USER@$HOST)
ntfy -t 'ntfy' send "Here's a notification with a custom title!"

# send a notification when the command `sleep 10` finishes
# this send the message '"sleep 10" succeeded in 0.2 minutes'
ntfy done sleep 10

Backends

Supported

  • Pushover
  • Pushbullet
  • XMPP
  • Linux Desktop Notifications
  • Windows Desktop Notifications
  • Mac OS X Notification Center

Config

ntfy is configured via a json config file stored at ~/.ntfy.json. It requires at minimum 1 keys: backends & a config for any backend that requires one.

For full docs consult the wiki

Example Config

{
    "backends": ["pushbullet"],
    "pushbullet": {"access_token": "<redacted>"}
}

Testing

python setup.py test

Contributors

  • dschep - Maintainer & Lead Developer
  • danryder - XMPP Backend & emoji support

Project details


Download files

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

Files for ntfy, version 0.7.0
Filename, size File type Python version Upload date Hashes
Filename, size ntfy-0.7.0-py2.py3-none-any.whl (23.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size ntfy-0.7.0.tar.gz (34.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page