Skip to content

Commit 4f25ef6

Browse files
committed
Update packaging information
1 parent 3ce6bde commit 4f25ef6

File tree

4 files changed

+74
-60
lines changed

4 files changed

+74
-60
lines changed

README.md

-56
This file was deleted.

README.rst

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
RoboHash
2+
========
3+
4+
The source code for `RoboHash.org`_.
5+
6+
It basically copy/pastes various robot pictures together, using bits
7+
from the SHA hash. It’s not perfect, and not entirely secure, but it
8+
gives a good gut-check to “Hey, this SHA is wrong.”
9+
10+
Install
11+
-------
12+
13+
Just the library:
14+
15+
.. code:: bash
16+
17+
$ pip install robohash
18+
19+
Or if you also want the web frontend:
20+
21+
.. code:: bash
22+
23+
$ pip install robohash[web]
24+
25+
Usage
26+
-----
27+
28+
.. code:: python
29+
30+
from robohash import Robohash
31+
32+
hash = "whatever-hash-you-want"
33+
rh = Robohash(hash)
34+
rh.assemble(roboset='any')
35+
with open("path/to/new/file.png", "w") as f:
36+
rh.img.save(f, format="png")
37+
38+
Robosets
39+
--------
40+
41+
RoboHash comes with three image sets, named “set1”, “set2”, and “set3”.
42+
Specify which set you want in the ``assemble()`` method. Alternatively,
43+
specify the string “any”, and RoboHash will pick an image set for you,
44+
based on the provided hash.
45+
46+
The “set1” artwork was created by Zikri Kader. The “set2” artwork was
47+
created by Hrvoje Novakovic. The “set3” artwork was created by Julian
48+
Peter Arias.
49+
50+
License
51+
-------
52+
53+
The Python Code is available under the MIT/Expat license. See the
54+
``LICENSE.txt`` file for the full text of this license. Copyright (c)
55+
2011, Colin Davis.
56+
57+
The RoboHash images are available under the CC-BY-3.0 license.
58+
59+
Disclaimer
60+
----------
61+
62+
OK, I’ll admit I’m a crappy programmer. Compounding this, I wrote this
63+
code initially to be internal-only. It’s ugly, and could be a LOT nicer.
64+
65+
Sorry about that.
66+
67+
.. _RoboHash.org: https://robohash.org/

setup.cfg

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
[metadata]
2-
description-file = README
2+
description-file = README.rst

setup.py

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
from distutils.core import setup
1+
try:
2+
from setuptools import setup
3+
except ImportError:
4+
from distutils.core import setup
25

3-
with open('README.txt') as file:
6+
with open('README.rst') as file:
47
long_description = file.read()
58

69
setup(
@@ -10,7 +13,7 @@
1013
description='One of the leading robot-based hashing tools on the web',
1114
long_description=long_description,
1215
author='Colin Davis',
13-
author_email='[email protected]',
16+
author_email='[email protected]',
1417
url='https://github.com/e1ven/Robohash',
1518
download_url='https://github.com/e1ven/Robohash/tarball/1.0',
1619
keywords=['robots'], # arbitrary keywords

0 commit comments

Comments
 (0)