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 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.2.1.tar.gz (32.3 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.2.1-py2.py3-none-any.whl (21.3 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for ntfy-0.2.1.tar.gz
Algorithm Hash digest
SHA256 c59ff959df45720c5d6c2da6ebd7b4c87732d049044e0b30c0bb2293fc84a559
MD5 74164e8966f96af2ef54454d9195599b
BLAKE2b-256 ef0616abaacd035ab4827de9c17b3b917b9dd624993c81c9f909b1cb5a7268b5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ntfy-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c1e39cf92981de29923a5994c291eee6887916d3793fd337e0787a2570488955
MD5 bfb34975d5d7bb5f1a4b02df228d2d00
BLAKE2b-256 6db6b6d4a71629dcff596e065947d27b3aab33ed716f7b83fde4dac32b805a48

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