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

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for ntfy-0.4.0.tar.gz
Algorithm Hash digest
SHA256 335eaea162a3721330fb77c87d075ee54cb908fa503804f7323a21c2ffb40f3d
MD5 3d69441aac662132cfec1fbb22c5fe6c
BLAKE2b-256 645b272462a59acb7b0009d5bdfbc76590d8cd528393cd5b3ad0467287e8f57d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ntfy-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dc0d92598747f617022e1eb2e12ddb39b9489043d0c5a980ab0a6892fe6e0dc1
MD5 b66ef97764f6ef42c4224b191f038561
BLAKE2b-256 18a846245742bc545a6bbd5348586659e4deefc81abaa25ea9639f382b308012

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