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, but Mac OS X & Windows notifications won’t work.

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 (notify-send)

  • Windows Desktop Notifications (requires PyWin32)

  • 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.1.5.tar.gz (32.2 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for ntfy-0.1.5.tar.gz
Algorithm Hash digest
SHA256 387983821c931d19396721de1c57fe55be5228a20c3fa83ff625cf57600976e2
MD5 c745fc40b14f064c31ac2526bf9eeaa0
BLAKE2b-256 6d68f43e6652ad9a9ef4d9f68ff60944d6b6f347b1a078d8517b532da8d1cedb

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