Merge pull request e1ven#15 from singingwolfboy/improve-setup-py

Project improvements!

Author: e1ven

README.md

@@ -0,0 +1,56 @@
+# RoboHash
+
+The source code for [RoboHash.org](https://robohash.org/).
+
+It basically copy/pastes various robot pictures together, using bits from
+the SHA hash. It's not perfect, and not entirely secure, but it gives
+a good gut-check to "Hey, this SHA is wrong."
+
+## Install
+
+Just the library:
+
+```bash
+$ pip install robohash
+```
+
+Or if you also want the web frontend:
+
+```bash
+$ pip install robohash[web]
+```
+
+## Usage
+
+```python
+from robohash import Robohash
+
+hash = "whatever-hash-you-want"
+rh = Robohash(hash)
+rh.assemble(roboset='any')
+with open("path/to/new/file.png", "w") as f:
+    rh.img.save(f, format="png")
+```
+
+## Robosets
+
+RoboHash comes with three image sets, named "set1", "set2", and "set3". Specify
+which set you want in the `assemble()` method. Alternatively, specify the string
+"any", and RoboHash will pick an image set for you, based on the provided hash.
+
+The "set1" artwork was created by Zikri Kader. The "set2" artwork was created by
+Hrvoje Novakovic. The "set3" artwork was created by Julian Peter Arias.
+
+## License
+
+The Python Code is available under the MIT/Expat license. See the `LICENSE.txt`
+file for the full text of this license. Copyright (c) 2011, Colin Davis.
+
+The RoboHash images are available under the CC-BY-3.0 license.
+
+## Disclaimer
+
+OK, I'll admit I'm a crappy programmer. Compounding this, I wrote this code
+initially to be internal-only. It's ugly, and could be a LOT nicer.
+
+Sorry about that.

README.txt

@@ -4,15 +4,33 @@
     long_description = file.read()
 
 setup(
-    name = 'robohash',
-    packages = ['robohash'], 
-    version = '1.0',
-    description = 'One of the leading robot-based hashing tools on the web',
+    name='robohash',
+    packages=['robohash'],
+    version='1.0',
+    description='One of the leading robot-based hashing tools on the web',
     long_description=long_description,
-    author = 'Colin Davis',
-    author_email = '[email protected]',
-    url = 'https://github.com/e1ven/Robohash',
-    download_url = 'https://github.com/e1ven/Robohash/tarball/1.0',
-    keywords = ['robots'], # arbitrary keywords
-    classifiers = [],
-)
+    author='Colin Davis',
+    author_email='[email protected]',
+    url='https://github.com/e1ven/Robohash',
+    download_url='https://github.com/e1ven/Robohash/tarball/1.0',
+    keywords=['robots'], # arbitrary keywords
+    license='MIT',
+    classifiers=[
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 2",
+        "Programming Language :: Python :: 3",
+        "Topic :: Security",
+    ],
+    package_data={
+        'robohash': [
+            'sets/set1/*/*/*',
+            'sets/set2/*/*',
+            'sets/set3/*/*',
+            'backgrounds/*/*',
+        ]
+    },
+    install_requires=['pillow', 'natsort'],
+    extras_require={
+        'web': ['tornado'],
+    },
+)