pypricklybird

Overview

pricklybird is a method for conversion of arbitrary binary data into more human-friendly words,
where each word represents a single byte.
A CRC-8 checksum is attached to allow the detection of errors during decoding.
0xDEADBEEF becomes turf-port-rust-warn-void, for example.

pypricklybird is a python implementation of pricklybird version v1.

Documentation

Documentation is generated using pdoc and can be found here.

Usage

Basic conversion functions that fully comply with the specification and include the CRC can be used as follows.

>>> from pypricklybird import convert_to_pricklybird, convert_from_pricklybird
>>> data = bytearray.fromhex("4243")
>>> code = convert_to_pricklybird(data);
>>> code # Notice the third word "full" used to encode the CRC.
'flea-flux-full'
>>> convert_from_pricklybird(code).hex()
'4243'

It is also possible to map word to bytes and bytes to words without the full standard implementation and CRC.

>>> from pypricklybird import words_to_bytes, bytes_to_words
>>> data = bytearray.fromhex("4243")
>>> words = bytes_to_words(data)
>>> words # Notice that no CRC is attached
['flea', 'flux']
>>> words_to_bytes(words).hex()
'4243'

Direct access to the WORDLIST used for mapping bytes to words, and the HASH_TABLE use to map words to bytes is also possible.

>>> from pypricklybird import WORDLIST, HASH_TABLE, word_hash
>>> # Confirm that the word flux maps to the byte 0x43 in both directions.
>>> word = "flux"
>>> table_index = word_hash(word[0], word[-1]);
>>> table_index
603
>>> byte_value = HASH_TABLE[table_index]
>>> hex(byte_value)
'0x43'

Installation

pip install pypricklybird

License

pypricklybird is distributed under the terms of the MIT license.