Permalink
Browse files

Initial work converting .md to .rst

Sinc pypi expects rst, it would be better to use that for the readme
and changelog
  • Loading branch information...
kfdm committed Mar 3, 2012
1 parent 839589c commit a7053e83ede8a9896e355819917e79258d3fac0f
Showing with 83 additions and 61 deletions.
  1. +0 −61 README.md
  2. +82 −0 README.rst
  3. +1 −0 setup.py
View
@@ -1,61 +0,0 @@
-# GNTP
-
-This is a Python library for working with the [Growl Notification Transport Protocol](http://www.growlforwindows.com/gfw/help/gntp.aspx)
-
-It should work as a dropin replacement for the older Python bindings
-
-
-## Installation
-You can install with pip
-
- $ pip install gntp
-
-then test the module
-
- $ python -m gntp.notifier
-
-## Simple Usage
-
-```python
-import gntp.notifier
-
-# Simple "fire and forget" notification
-gntp.notifier.mini("Here's a quick message")
-
-# More complete example
-growl = gntp.notifier.GrowlNotifier(
- applicationName = "My Application Name",
- notifications = ["New Updates","New Messages"],
- defaultNotifications = ["New Messages"],
- # hostname = "computer.example.com", # Defaults to localhost
- # password = "abc123" # Defaults to a blank password
-)
-growl.register()
-
-# Send one message
-growl.notify(
- noteType = "New Messages",
- title = "You have a new message",
- description = "A longer message description",
- icon = "http://example.com/icon.png",
- sticky = False,
- priority = 1,
-)
-
-# Try to send a different type of message
-# This one may fail since it is not in our list
-# of defaultNotifications
-growl.notify(
- noteType = "New Updates",
- title = "There is a new update to download",
- description = "A longer message description",
- icon = "http://example.com/icon.png",
- sticky = False,
- priority = -1,
-)
-
-```
-
-## Bugs
-
-[GitHub issue tracker](https://github.com/kfdm/gntp/issues)
View
@@ -0,0 +1,82 @@
+GNTP
+====
+
+This is a Python library for working with the `Growl Notification
+Transport Protocol <http://www.growlforwindows.com/gfw/help/gntp.aspx>`_
+
+It should work as a dropin replacement for the older Python bindings
+
+Installation
+------------
+
+You can install with pip
+
+::
+
+ $ pip install gntp
+
+then test the module
+
+::
+
+ $ python -m gntp.notifier
+
+Simple Usage
+------------
+
+::
+
+ import gntp.notifier
+
+ # Simple "fire and forget" notification
+ gntp.notifier.mini("Here's a quick message")
+
+ # More complete example
+ growl = gntp.notifier.GrowlNotifier(
+ applicationName = "My Application Name",
+ notifications = ["New Updates","New Messages"],
+ defaultNotifications = ["New Messages"],
+ # hostname = "computer.example.com", # Defaults to localhost
+ # password = "abc123" # Defaults to a blank password
+ )
+ growl.register()
+
+ # Send one message
+ growl.notify(
+ noteType = "New Messages",
+ title = "You have a new message",
+ description = "A longer message description",
+ icon = "http://example.com/icon.png",
+ sticky = False,
+ priority = 1,
+ )
+
+ # Try to send a different type of message
+ # This one may fail since it is not in our list
+ # of defaultNotifications
+ growl.notify(
+ noteType = "New Updates",
+ title = "There is a new update to download",
+ description = "A longer message description",
+ icon = "http://example.com/icon.png",
+ sticky = False,
+ priority = -1,
+ )
+
+Bugs
+----
+
+`GitHub issue tracker <https://github.com/kfdm/gntp/issues>`_
+
+
+Changelog
+---------
+
+`v0.7 <https://github.com/kfdm/gntp/compare/0.6...v0.7>`_
+ - Support for images
+ - Better test coverage support
+
+`0.6 <https://github.com/kfdm/gntp/compare/0.5...0.6>`_
+ - ConfigParser aware GrowlNotifier that reads settings from ~/.gntp
+
+
View
@@ -10,6 +10,7 @@
setup(
name='gntp',
description='Growl Notification Transport Protocol for Python',
+ long_description=open('README.rst').read(),
author='Paul Traylor',
url='http://github.com/kfdm/gntp/',
version=gntp.__version__,

0 comments on commit a7053e8

Please sign in to comment.