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

  • 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 2 keys: backend & a config for that backend.

For full docs consult the wiki

Example Config

{
    "backend": "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.2.0.tar.gz (32.5 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for ntfy-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9eef6bbba106ad7ea8f1954d977370ef8610bc5b37d2506a1753aae3ed249450
MD5 02f204ecbb9bf1deace179b8482d8cc9
BLAKE2b-256 2ff9447c4cd6bacb4c7217b620693bb3ba0ef6b419b470e872bb54c430da0908

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