Skip to content

Commit

Permalink
Switch to reStructuredText for README (better for PyPi!)
Browse files Browse the repository at this point in the history
  • Loading branch information
dschep committed Jan 4, 2016
1 parent 5376dba commit 6b1569a
Show file tree
Hide file tree
Showing 5 changed files with 84 additions and 68 deletions.
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
include MANIFEST.in
include README.md
include README.rst
include LICENSE
59 changes: 0 additions & 59 deletions README.md

This file was deleted.

81 changes: 81 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
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://cdn.rawgit.com/dschep/ntfy/master/demo/ntfy-demo.mp4>`_

.. image:: 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 <https://pushover.net>`_
- `Pushbullet <https://pushbullet.com>`_
- Linux Desktop Notifications (notify-send)
- Windows Desktop Notifications (requires `PyWin32 <http://sourceforge.net/projects/pywin32/>`_)
- Mac OS X Notification Center

ToDo
----
- `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>"}}
}
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[metadata]
description-file = README.md
description-file = README.rst
8 changes: 1 addition & 7 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
from setuptools import setup
from codecs import open # To use a consistent encoding
from os import path

here = path.abspath(path.dirname(__file__))

# Get the long description from the relevant file
with open(path.join(here, 'README.md'), encoding='utf-8') as f:
long_description = f.read()

setup(
name='ntfy',

version='0.1.4',
version='0.1.5',

description='A utility for sending push notifications',
long_description=long_description,

url='https://github.com/dschep/ntfy',

Expand Down

0 comments on commit 6b1569a

Please sign in to comment.