<commit_before>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`_

.. code::

    pip install mnemonicode


Links
-----

- Source code: https://github.com/bwhmather/python-mnemonicode
- Issue tracker: https://github.com/bwhmather/python-mnemonicode/issues
- Continuous integration: https://travis-ci.org/bwhmather/python-mnemonicode
- PyPI: https://pypi.python.org/pypi/mnemonicode


License
-------

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


.. |build-status| image:: https://travis-ci.org/bwhmather/python-mnemonicode.png?branch=develop
    :target: https://travis-ci.org/bwhmather/python-mnemonicode
    :alt: Build Status
.. |coverage| image:: https://coveralls.io/repos/bwhmather/python-mnemonicode/badge.png?branch=develop
    :target: https://coveralls.io/r/bwhmather/python-mnemonicode?branch=develop
    :alt: Coverage
.. _pypi: https://pypi.python.org/pypi/mnemonicode
.. _LICENSE: ./LICENSE<commit_msg>Included Usage in README contents for clarity<commit_after>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`_

.. code::

    pip install mnemonicode


Usage
-----

Encode
.. code::

    import mnemonicode as mn
    with open(infile, 'rb') as f:
        data = f.read()
    
    output = mn.mnformat(data)
    with open(outfile, 'w') as f:
        f.write(output)

Decode
.. code::
    import mnemonicode as mn
    with open(infile, 'r') as f:
        data = f.read()
    
    output = mn.mnparse(data)
    with open(outfile, 'wb') as f:
        f.write(output)


Links
-----

- Source code: https://github.com/bwhmather/python-mnemonicode
- Issue tracker: https://github.com/bwhmather/python-mnemonicode/issues
- Continuous integration: https://travis-ci.org/bwhmather/python-mnemonicode
- PyPI: https://pypi.python.org/pypi/mnemonicode


License
-------

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


.. |build-status| image:: https://travis-ci.org/bwhmather/python-mnemonicode.png?branch=develop
    :target: https://travis-ci.org/bwhmather/python-mnemonicode
    :alt: Build Status
.. |coverage| image:: https://coveralls.io/repos/bwhmather/python-mnemonicode/badge.png?branch=develop
    :target: https://coveralls.io/r/bwhmather/python-mnemonicode?branch=develop
    :alt: Coverage
.. _pypi: https://pypi.python.org/pypi/mnemonicode
.. _LICENSE: ./LICENSE
{'fraction_non_alphanumeric': 0.152864044168392, 'fraction_numerical': 0.00966183574879227, 'mean_word_length': 3.439509954058193, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 18, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '161997', 'n_tokens_mistral': 1019, 'n_tokens_neox': 987, 'n_words': 210}