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 for full demo![Click for full demo](demo/ntfy-demo.gif)](https://cdn.rawgit.com/dschep/ntfy/master/demo/ntfy-demo.mp4)

## 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
- [x] [Pushover](https://pushover.net)
- [x] [Pushbullet](https://pushbullet.com)
- [x] Linux Desktop Notifications (notify-send)
- [X] Windows Desktop Notifications (requires [PyWin32](http://sourceforge.net/projects/pywin32/))
- [x] Mac OS X Notification Center
- [ ] [Prowl](http://www.prowlapp.com)
- [ ] [Airgram](http://www.airgramapp.com)
- [ ] [Pushjet](https://pushjet.io)
- [ ] [Pushalot](https://pushalot.com)
- [ ] [Boxcar](https://boxcar.io)
- [ ] [Instapush](https://instapush.im)

## 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](https://github.com/dschep/ntfy/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.4.tar.gz (33.2 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for ntfy-0.1.4.tar.gz
Algorithm Hash digest
SHA256 90f7824f030173be27212a86d113ebc1e1c24fbb9ad1fa7aa40ab7c7b5778379
MD5 71ae0a5adfef89af66c0949df16ac531
BLAKE2b-256 b339fc0633104093d6327b7fd9ee5882604ed530dab0292b40062e587677dd0d

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