Robohash/README.rst

86 lines
2.1 KiB
ReStructuredText
Raw Normal View History

2017-07-13 13:49:58 -04:00
RoboHash
========
The source code for `RoboHash.org`_.
It basically copy/pastes various robot pictures together, using bits
2018-12-03 17:05:55 +01:00
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."
2017-07-13 13:49:58 -04:00
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", "wb") as f:
2017-07-13 13:49:58 -04:00
rh.img.save(f, format="png")
Robosets
--------
RoboHash comes with five image sets, named "set1", "set2", "set3", "set4" and "set5".
2017-07-13 13:49:58 -04:00
Specify which set you want in the ``assemble()`` method. Alternatively,
2018-12-03 17:05:55 +01:00
specify the string "any", and RoboHash will pick an image set for you,
2017-07-13 13:49:58 -04:00
based on the provided hash.
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)
2022-09-12 22:05:24 -04:00
2011.
2017-07-13 13:49:58 -04:00
Feel free to embed the Robohash images, host your own instance of Robohash,
or integrate them into your own project.
If you do, please just mention where they came from :)
Example wording might be "Robots lovingly delivered by Robohash.org" or similar.
2019-08-28 11:55:12 -04:00
The "set1" artwork (and robohash backgrounds) were created by Zikri Kader.
2019-08-28 11:55:12 -04:00
They are available under CC-BY-3.0 or CC-BY-4.0 license.
The "set2" artwork was created by Hrvoje Novakovic.
They are available under CC-BY-3.0 license.
The "set3" artwork was created by Julian Peter Arias.
They are available under CC-BY-3.0 license.
The Cats/"set4" were created by David Revoy, used under CC-BY-4.0
https://www.peppercarrot.com/en/article391/cat-avatar-generator
The avatars used in "set5" were created by Pablo Stanley, for https://avataaars.com/
They are "Free for personal and commercial use. 😇"
2017-07-13 13:49:58 -04:00
Disclaimer
----------
2018-12-03 17:05:55 +01:00
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.
2017-07-13 13:49:58 -04:00
Sorry about that.
.. _RoboHash.org: https://robohash.org/