https://github.com/moreati/python-niceware

Niceware for Python - convert cryptographic keys to human-readable phrases, and back again
https://github.com/moreati/python-niceware

Last synced: 6 months ago
JSON representation

Niceware for Python - convert cryptographic keys to human-readable phrases, and back again

• Host: GitHub
• URL: https://github.com/moreati/python-niceware
• Owner: moreati
• License: mit
• Created: 2017-03-16T23:32:16.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-12-10T05:50:55.000Z (almost 5 years ago)
• Last Synced: 2025-04-05T00:35:24.422Z (6 months ago)
• Language: Python
• Homepage: https://pypi.python.org/pypi/niceware
• Size: 222 KB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
Niceware for Python

===================

.. image:: https://img.shields.io/pypi/v/niceware.svg

        :target: https://pypi.python.org/pypi/niceware

        :alt: PyPI status

.. image:: https://img.shields.io/travis/moreati/python-niceware.svg

        :target: https://travis-ci.org/moreati/python-niceware

        :alt: Build status

.. image:: https://readthedocs.org/projects/python-niceware/badge/?version=latest

        :target: https://python-niceware.readthedocs.io/en/latest/?badge=latest

        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/moreati/python-niceware/shield.svg

     :target: https://pyup.io/repos/github/moreati/python-niceware/

     :alt: Updates

Python port of Niceware_. Generate random-yet-memorable passphrasese,

or convert encryption keys to english phrases and back again.

Each word provides 16 bits of entropy, so a useful password requires at least

3 words.

Because the wordlist is of exactly size 2^16, Niceware is also useful for converting cryptographic keys and other sequences of random bytes into human-readable phrases. With Niceware, a 128-bit key is equivalent to an 8-word phrase.

* Free software: MIT license

* Documentation: https://python-niceware.readthedocs.io.

Usage

-----

To insall

.. code:: console

    $ pip install niceware

To generate an 8-byte passphrase

.. code:: python

    >>> import niceware

    >>> niceware.generate_passphrase(8)

    ['deathtrap', 'stegosaur', 'nilled', 'nonscheduled']

or from the command line

.. code:: console

    $ niceware --words 5

    tincturing distasting await trusser treadler

Niceware for Python uses ``os.urandom`` for entropy.

Credits

-------

Niceware for Python is a port of Niceware_, by yan_.

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Niceware: https://github.com/diracdeltas/niceware

.. _yan: https://diracdeltas.github.io/blog/about/

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage