Adjusted readme text

Author: oohlaf

CHANGELOG.md

@@ -5,7 +5,7 @@
 ### Added
 - Port to Python 3.
 - Added PyPy support (PyPy3 does not work due to functions
-  that have not yet been ported).
+  that have not yet been ported, like `PyUnicode_New`).
 - Added Continuous Integration using Travis-CI.
 
 ### Fixed
@@ -32,7 +32,7 @@
 - The `hash()` function is deprecated. Please transition to the hashlib
   interface and use `new()` and `hexdigest()`.
 
-## 0.2 - Never released
+## 0.2 - Unreleased
 
 ## [0.1] - 2011-05-18
 

README.md

@@ -4,14 +4,29 @@
 python-whirlpool
 ================
 
-The Whirlpool algorithm is designed by Vincent Rijmen and Paulo S.L.M. Barreto.
-This is just a wrapper to the Whirlpool C reference implementation. 
+The [Whirlpool] algorithm is designed by Vincent Rijmen and Paulo S.L.M. Barreto.
+It is a secure and modern digest function that has been recommended by the
+[NESSIE] project and adopted in the ISO/IEC 10118-3 international standard.
+
+Digest functions, also known as hash functions, produce fixed-length output (a
+digest or hash) from a variable-length message. They are designed to be a
+one-way function.
+
+This library is a Python wrapper around the Whirlpool C reference implementation.
 The Whirlpool reference implementations are public domain, as is this code.
 
-Wrapper written by James Cleveland with help from #python on irc.freenode.net.
+The first version of the wrapper was written by James Cleveland with help
+from #python on irc.freenode.net.
+
+Later on the wrapper was rewritten by Olaf Conradi to use the hashlib interface
+and made compatible with Python 3.
+
+Installation
+------------
 
-Wrapper extended to use the hashlib interface and ported to Python 3 by
-Olaf Conradi.
+This library is available on [PyPi].
+
+    pip install whirlpool
 
 Usage
 -----
@@ -34,7 +49,32 @@ You need to specify the encoding of these strings before hashing.
 
 Strings that are marked as binary do not need encoding.
 
+Development
+-----------
+
+The source code is available on [GitHub].
+
+    git clone https://github.com/oohlaf/python-whirlpool.git
+    cd python-whirlpool
+
+Install in development mode using:
+
+    python setup.py develop
+
+Or install in editable mode using pip:
+
+    pip install -e .
+
 Testing
 -------
 
-This module is tested using Python 2.7 and Python 3.3.
+This module is tested using Python 2.7, Pypy, and Python 3.3 and up.
+
+You can run the testsuite using
+
+    python setup.py test
+
+[Whirlpool]: https://en.wikipedia.org/wiki/Whirlpool_(cryptography)
+[NESSIE]: https://www.cosic.esat.kuleuven.be/nessie/
+[PyPi]: https://pypi.python.org/pypi/Whirlpool
+[GitHub]: https://github.com/oohlaf/python-whirlpool

setup.py

@@ -1,21 +1,29 @@
-""" Whirlpool: Bindings for whirlpool hash reference implementation.
-
-The Whirlpool hashing algorithm (http://www.larc.usp.br/~pbarreto/WhirlpoolPage.html),
-written by Vincent Rijmen and Paulo S. L. M. Barreto is a secure, modern hash which is
-as yet unbroken and fairly obscure. Provided on the algorithm's page is a C reference
-implementation which is fairly simple to wrap with a Python extension, which is much
-faster than re-implementation in pure Python.
-"""
+"""Whirlpool: Bindings for whirlpool hash reference implementation."""
+import os
+import sys
+
 from setuptools import setup, Extension
 
+if sys.version_info.major < 3:
+    from io import open
+
+
+doclines = __doc__.strip().split('\n')
+
+
+HERE = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(HERE, 'README.md'), encoding='utf-8') as f:
+    README = '\n' + f.read()
+with open(os.path.join(HERE, 'CHANGELOG.md'), encoding='utf-8') as f:
+    CHANGELOG = '\n' + f.read()
 
-doclines = __doc__.split("\n")
 
 setup(name = "Whirlpool",
     version = "1.0.0.dev1",
     description = doclines[0],
-    long_description = "\n".join(doclines[2:]),
+    long_description = README + '\n' + CHANGELOG,
     classifiers=[
+        "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",
         "License :: Public Domain",
         "Programming Language :: C",
@@ -24,6 +32,10 @@
         "Programming Language :: Python :: 2.7",
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: Implementation :: PyPy",
         "Topic :: Security :: Cryptography",
         "Topic :: Software Development :: Libraries :: Python Modules",
         ],