Coder Social home page Coder Social logo

python-mnemonicode's Introduction

Python Mnemonicode

Build Status Coverage

A python library for encoding binary data as a sequence of english words.

Based on, and compatible with http://web.archive.org/web/20101031205747/http://www.tothink.com/mnemonic/

Installation

Recommended method is to use the version from pypi

$ pip install mnemonicode

Please note that this library supports python 3 only.

Usage

Python mnemonicode exposes four functions: mnformat and mnparse for handling conversions to and from formatted strings, and mnencode and mndecode for working with lower level lists of tuples of words.

String encoding

Encode a byte array as a sequence of grouped words, formatted as a single string:

>>> mnformat(b"cucumber")
'paris-pearl-ultra--gentle-press-total';

Decode a mnemonicode string into a byte array:

>>> mnparse('scoop-limit-recycle--ferrari-album')
b'tomato'

Both functions allow specifying the word and group separator. It is safe for the word separator to match part of the group separator, but not the other way round. Word and group separators that overlap with word in the dictionary should obviously be avoided.

An example using custom separators:

>>> mnemonicode.mnformat(
...     b'apricot', group_separator=', uhhh, ', word_separator=', um, '
... )
'arctic, um, dilemma, um, single, uhhh, presto, um, mask, um, jet'

Tuple encoding

Encode a bytes object as an iterator of tuples of words:

>>> list(mnencode(b"avocado"))
[('bicycle', 'visible', 'robert'), ('cloud', 'unicorn', 'jet')]

Decode an iterator of tuples of words to get a byte array:

>>> mndecode([('turtle', 'special', 'recycle'), ('ferrari', 'album')])
b'potato'

Links

License

The project is licensed under the BSD license. See LICENSE for details.

python-mnemonicode's People

Contributors

bwhmather avatar cashiuus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

python-mnemonicode's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.