Skip to main content

A utility for sending push notifications

Project description

About ntfy

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

Click here for full demo

https://raw.githubusercontent.com/dschep/ntfy/master/demo/ntfy-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 send -t 'ntfy' "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

ToDo

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>"}
}

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

ntfy-0.5.0.tar.gz (34.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ntfy-0.5.0-py2.py3-none-any.whl (23.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ntfy-0.5.0.tar.gz.

File metadata

  • Download URL: ntfy-0.5.0.tar.gz
  • Upload date:
  • Size: 34.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ntfy-0.5.0.tar.gz
Algorithm Hash digest
SHA256 bdec6a8a2f2c0dec637a73a4c9fa2f4b9d4a6e0d0606502ae4feacef73dfd18a
MD5 53e431796542d2938a2170e4e82fb14a
BLAKE2b-256 eb5e9948e90534156f9e4ee4366f680e67da92c5fcd63db918c79e56401c57b2

See more details on using hashes here.

File details

Details for the file ntfy-0.5.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ntfy-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1acb07f2350e68fda4c94ea12c3cff6d5277ed8eb9e9fddf8d2e36ec7d766ae0
MD5 696b9c2fdcc66954f44634974ba3cdee
BLAKE2b-256 24fb4851e3de7ee211215a31d7af58ac27fe9cc59c7c7a63b190dbb8bf03b3d1

See more details on using hashes here.

Supported by

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