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.0.tar.gz (32.6 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.0-py2.py3-none-any.whl (50.0 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for ntfy-0.3.0.tar.gz
Algorithm Hash digest
SHA256 e1aa4a5a428a5052b456bdb42b908c0ea477cd64ad1fe9f0fa33e231b2be9b76
MD5 375d6a3df39c05cceb39b6bdd1d618b1
BLAKE2b-256 8a21fbb14e9517293e4c0a561f2129271f08ccd822a2a801cefcfbd4859df6ee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ntfy-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 315f861d5b16c27022dce84ebbcf789496389c24b20eabf691fe2c7b6e34c970
MD5 4ad4bb9deca822be4750db4d9bd186c6
BLAKE2b-256 abc04ef94aab036b0335fa2498091498f2808ce42d37ce73f9789049c0c7c8db

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