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 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.3.1.tar.gz (33.2 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.3.1-py2.py3-none-any.whl (21.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for ntfy-0.3.1.tar.gz
Algorithm Hash digest
SHA256 af4cd2a7cf68226e635704a5f7630b093e5912e571eb609327b99ed03112ac4b
MD5 0c5fb03a5774eec41d43ecc8106c10e6
BLAKE2b-256 4d26a7b39dd3d8ed54e371aa00bdfbeb44adf281b7de97a7f2437265979e7a73

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ntfy-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 16df8a84d1008ab2e9006f4d8cc4d78d56de4082eeb843e4e3fc7cae886320c9
MD5 d903dcb36d344882faa53d12c530ae03
BLAKE2b-256 ba5f04b66e8e753d443007e80b1e6cca775ae561d3536568f4398a9021508390

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