mirror of
https://github.com/e1ven/Robohash.git
synced 2025-06-23 21:35:02 +00:00
Update packaging information
This commit is contained in:
parent
d56f52a958
commit
d76ffc3752
56
README.md
56
README.md
@ -1,56 +0,0 @@
|
||||
# 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.
|
67
README.rst
Normal file
67
README.rst
Normal file
@ -0,0 +1,67 @@
|
||||
RoboHash
|
||||
========
|
||||
|
||||
The source code for `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:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ pip install robohash
|
||||
|
||||
Or if you also want the web frontend:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ pip install robohash[web]
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
.. code:: 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.
|
||||
|
||||
.. _RoboHash.org: https://robohash.org/
|
@ -1,2 +1,2 @@
|
||||
[metadata]
|
||||
description-file = README
|
||||
description-file = README.rst
|
||||
|
9
setup.py
9
setup.py
@ -1,6 +1,9 @@
|
||||
from distutils.core import setup
|
||||
try:
|
||||
from setuptools import setup
|
||||
except ImportError:
|
||||
from distutils.core import setup
|
||||
|
||||
with open('README.txt') as file:
|
||||
with open('README.rst') as file:
|
||||
long_description = file.read()
|
||||
|
||||
setup(
|
||||
@ -10,7 +13,7 @@ setup(
|
||||
description='One of the leading robot-based hashing tools on the web',
|
||||
long_description=long_description,
|
||||
author='Colin Davis',
|
||||
author_email='cdavis@tavern.is',
|
||||
author_email='colin@robohash.org',
|
||||
url='https://github.com/e1ven/Robohash',
|
||||
download_url='https://github.com/e1ven/Robohash/tarball/1.0',
|
||||
keywords=['robots'], # arbitrary keywords
|
||||
|
Loading…
x
Reference in New Issue
Block a user