Metadata-Version: 2.4
Name: humanhash3
Version: 0.0.6
Summary: Human-readable representations of digests.
Home-page: https://github.com/blag/humanhash
Author: Zachary Voase
Author-email: z@zacharyvoase.com
License: Public Domain
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Security
Classifier: Topic :: Utilities
Classifier: License :: Public Domain
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: summary

humanhash
=========

humanhash provides human-readable representations of digests.

.. image:: https://img.shields.io/travis/blag/humanhash.svg
    :target: https://travis-ci.org/blag/humanhash

.. image:: https://img.shields.io/coveralls/blag/humanhash.svg
    :target: https://coveralls.io/github/blag/humanhash

.. image:: https://img.shields.io/pypi/v/humanhash3.svg
    :target: https://pypi.python.org/pypi/humanhash3

.. image:: https://img.shields.io/pypi/l/humanhash3.svg
    :target: https://github.com/blag/humanhash/blob/master/UNLICENSE

.. image:: https://img.shields.io/pypi/pyversions/humanhash3.svg
    :target: https://github.com/blag/humanhash/blob/master/.travis.yml

Example
-------

.. code-block:: python

    >>> import humanhash

    >>> digest = '7528880a986c40e78c38115e640da2a1'
    >>> humanhash.humanize(digest)
    'three-georgia-xray-jig'
    >>> humanhash.humanize(digest, words=6)
    'high-mango-white-oregon-purple-charlie'

    >>> humanhash.uuid()
    ('potato-oranges-william-friend', '9d2278759ae24698b1345525bd53358b')

Caveats
-------

Don't store the humanhash output, as its statistical uniqueness is only
around 1 in 4.3 billion. Its intended use is as a human-readable (and,
most importantly, **memorable**) representation of a longer digest,
unique enough for display in a user interface, where a user may need to
remember or verbally communicate the identity of a hash, without having
to remember a 40-character hexadecimal sequence. Nevertheless, you
should keep original digests around, then pass them through
``humanize()`` only as you're displaying them.

How It Works
------------

The procedure for generating a humanhash involves compressing the input
to a fixed length (default: 4 bytes), then mapping each of these bytes
to a word in a pre-defined wordlist (a default wordlist is supplied with
the library). This algorithm is consistent, so the same input, given the
same wordlist, will always give the same output. You can also use your
own wordlist, and specify a different number of words for output.

Inspiration
-----------

- `Chroma-Hash`_ - A human-viewable representation of a hash (albeit not
  one that can be output on a terminal, or shouted down a hallway).
- `The NATO Phonetic Alphabet`_ - A great example of the trade-off
  between clarity of human communication and byte-wise efficiency of
  representation.

.. _Chroma-Hash: http://mattt.github.com/Chroma-Hash/
.. _The NATO Phonetic Alphabet: http://en.wikipedia.org/wiki/NATO_phonetic_alphabet
