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.1.tar.gz (33.8 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.1-py2.py3-none-any.whl (22.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for ntfy-0.5.1.tar.gz
Algorithm Hash digest
SHA256 0fcceb21cbbd492c6c515c56ae2ec2947bc0c693a07ad51a392517479e479612
MD5 99a53f64c5b30fc42e28d4204acd478a
BLAKE2b-256 6972419ece961f2737fdc29fefc62f2e62498dfa7e4cd19cbe9b5f6ca3849a42

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ntfy-0.5.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 57e64711930eb8f4f46ef12d3581f576ce0122db0eecee6b3ce48f825526b41d
MD5 9aa9103ec094a6d269c4d209db67a746
BLAKE2b-256 0ca894d71a9e72025e6147900529f70c68547335840f9d4a91ec84a6f091e474

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