Commits

Jeffrey Goettsch  committed aaff248

Renamed all .txt files to .rst files (they are reStructuredText after all).

  • Participants
  • Parent commits 8836a13

Comments (0)

Files changed (14)

+Authors
+-------
+
+The primary author of pushnotify is Jeffrey Goettsch <jgoettsch@gmail.com>
+who may be found online at https://bitbucket.org/jgoettsch/.

File AUTHORS.txt

-Authors
--------
-
-The primary author of pushnotify is Jeffrey Goettsch <jgoettsch@gmail.com>
-who may be found online at https://bitbucket.org/jgoettsch/.

File CHANGELOG.rst

+Changelog
+---------
+
+version 0.3.1
+
+* Prowl.Client.retrieve_token and Prowl.Client.retrieve_apikey now raise a pushnotify.exceptions.ProviderKeyError if the specified Provider Key is invalid
+
+version 0.3
+
+* added support for Prowl: http://www.prowlapp.com/
+
+version 0.2.1
+
+* fixed an issue where developer keys were not being sent with Notify My Android verifications
+
+version 0.2
+
+* added support for Pushover: https://pushover.net/
+
+version 0.1
+
+* added support for Notify My Android: https://www.notifymyandroid.com/

File CHANGELOG.txt

-Changelog
----------
-
-version 0.3.1
-
-* Prowl.Client.retrieve_token and Prowl.Client.retrieve_apikey now raise a pushnotify.exceptions.ProviderKeyError if the specified Provider Key is invalid
-
-version 0.3
-
-* added support for Prowl: http://www.prowlapp.com/
-
-version 0.2.1
-
-* fixed an issue where developer keys were not being sent with Notify My Android verifications
-
-version 0.2
-
-* added support for Pushover: https://pushover.net/
-
-version 0.1
-
-* added support for Notify My Android: https://www.notifymyandroid.com/
+Installation
+------------
+
+If you have already downloaded pushnotify, run the following
+command inside this directory::
+
+    $ python setup.py install
+
+If you have not yet downloaded pushnotify, it would be easier to do
+the following::
+
+    $ pip install pushnotify
+
+Either method will install pushnotify into your current environment.

File INSTALL.txt

-Installation
-------------
-
-If you have already downloaded pushnotify, run the following
-command inside this directory::
-
-    $ python setup.py install
-
-If you have not yet downloaded pushnotify, it would be easier to do
-the following::
-
-    $ pip install pushnotify
-
-Either method will install pushnotify into your current environment.
+Copyright (c) Jeffrey Goettsch and other contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Jeffrey Goettsch nor the
+      names of the contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL JEFFREY GOETTSCH OR THE CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

File LICENSE.txt

-Copyright (c) Jeffrey Goettsch and other contributors.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of Jeffrey Goettsch nor the
-      names of the contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL JEFFREY GOETTSCH OR THE CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-include AUTHORS.txt
-include CHANGELOG.txt
-include INSTALL.txt
-include LICENSE.txt
-include README.txt
-include TODO.txt
+include AUTHORS.rst
+include CHANGELOG.rst
+include INSTALL.rst
+include LICENSE.rst
+include README.rst
+include TODO.rst
 recursive-include docs *
 exclude pushnotify/tests/nmakeys.py
 exclude pushnotify/tests/prowlkeys.py
+==========
+pushnotify
+==========
+
+pushnotify is a package for sending push notifications. It currently
+supports Android devices running Notify My Android and Pushover, and iOS
+devices running Pushover and Prowl.
+
+See
+
+* https://www.notifymyandroid.com/
+* https://pushover.net/ and
+* http://www.prowlapp.com/
+
+for more details about these applications.
+
+Development
+-----------
+
+All development for pushnotify takes place on bitbucket:
+
+* https://bitbucket.org/jgoettsch/py-pushnotify/
+
+To get started you can do the following::
+
+    $ hg clone https://bitbucket.org/jgoettsch/py-pushnotify/
+    $ cd py-pushnotify
+    $ pip install -r requirements_dev.txt
+
+If you discover a bug, please create an issue ticket:
+
+* https://bitbucket.org/jgoettsch/py-pushnotify/issues/new
+
+To run the test suite, you will have to create three modules:
+
+* pushnotify/tests/nmakeys.py:
+
+    This file must contain two global variables: API_KEYS and
+    DEVELOPER_KEY. API_KEYS is a list containing at least one valid API
+    key as a string. DEVELOPER_KEY is a string containing a valid
+    developer key.
+    
+* pushnotify/tests/prowlkeys.py:
+
+    This file must contain two global variables: API_KEYS and
+    PROVIDER_KEY. API_KEYS is a list containing at least one valid API
+    key as a string. PROVIDER_KEY is a string containing a valid
+    provider key. REG_TOKEN is a valid registration token that has
+    already been validated through the retrieve_token/retrieve_apikey
+    process.
+
+* pushnotify/tests/pushoverkeys.py:
+
+    This file must contain three global variables: TOKEN, USER, and
+    DEVICE. TOKEN is a string containing a valid API token. USER is a
+    string containing a valid user identifier. DEVICE is a string
+    containing a valid device identifier for the given user.

File README.txt

-==========
-pushnotify
-==========
-
-pushnotify is a package for sending push notifications. It currently
-supports Android devices running Notify My Android and Pushover, and iOS
-devices running Pushover and Prowl.
-
-See
-
-* https://www.notifymyandroid.com/
-* https://pushover.net/ and
-* http://www.prowlapp.com/
-
-for more details about these applications.
-
-Development
------------
-
-All development for pushnotify takes place on bitbucket:
-
-* https://bitbucket.org/jgoettsch/py-pushnotify/
-
-To get started you can do the following::
-
-    $ hg clone https://bitbucket.org/jgoettsch/py-pushnotify/
-    $ cd py-pushnotify
-    $ pip install -r requirements_dev.txt
-
-If you discover a bug, please create an issue ticket:
-
-* https://bitbucket.org/jgoettsch/py-pushnotify/issues/new
-
-To run the test suite, you will have to create three modules:
-
-* pushnotify/tests/nmakeys.py:
-
-    This file must contain two global variables: API_KEYS and
-    DEVELOPER_KEY. API_KEYS is a list containing at least one valid API
-    key as a string. DEVELOPER_KEY is a string containing a valid
-    developer key.
-    
-* pushnotify/tests/prowlkeys.py:
-
-    This file must contain two global variables: API_KEYS and
-    PROVIDER_KEY. API_KEYS is a list containing at least one valid API
-    key as a string. PROVIDER_KEY is a string containing a valid
-    provider key. REG_TOKEN is a valid registration token that has
-    already been validated through the retrieve_token/retrieve_apikey
-    process.
-
-* pushnotify/tests/pushoverkeys.py:
-
-    This file must contain three global variables: TOKEN, USER, and
-    DEVICE. TOKEN is a string containing a valid API token. USER is a
-    string containing a valid user identifier. DEVICE is a string
-    containing a valid device identifier for the given user.
+Tasks/TODO
+----------
+
+For all tasks and issues, see the issues list on bitbucket:
+
+* https://bitbucket.org/jgoettsch/py-pushnotify/issues

File TODO.txt

-Tasks/TODO
-----------
-
-For all tasks and issues, see the issues list on bitbucket:
-
-* https://bitbucket.org/jgoettsch/py-pushnotify/issues
 
 version = '0.3.1p'
 
-with open('README.txt') as fh:
+with open('README.rst') as fh:
     long_description = fh.read()
 
-with open('INSTALL.txt') as fh:
+with open('INSTALL.rst') as fh:
     long_description = '\n\n'.join([long_description, fh.read()])
 
-with open('CHANGELOG.txt') as fh:
+with open('CHANGELOG.rst') as fh:
     long_description = '\n\n'.join([long_description, fh.read()])
 
 setup(