https://github.com/trezor/python-mnemonic

:snake: Mnemonic code for generating deterministic keys, BIP39
https://github.com/trezor/python-mnemonic

bip39 bitcoin mnemonic python trezor

Last synced: about 21 hours ago
JSON representation

:snake: Mnemonic code for generating deterministic keys, BIP39

• Host: GitHub
• URL: https://github.com/trezor/python-mnemonic
• Owner: trezor
• License: mit
• Created: 2013-02-18T12:40:34.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-01-05T10:46:49.000Z (10 months ago)
• Last Synced: 2024-05-22T03:44:44.871Z (6 months ago)
• Topics: bip39, bitcoin, mnemonic, python, trezor
• Language: Python
• Homepage: https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki
• Size: 462 KB
• Stars: 806
• Watchers: 38
• Forks: 355
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
python-mnemonic

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

.. image:: https://badge.fury.io/py/mnemonic.svg

    :target: https://badge.fury.io/py/mnemonic

Reference implementation of BIP-0039: Mnemonic code for generating

deterministic keys

Abstract

--------

This BIP describes the implementation of a mnemonic code or mnemonic sentence --

a group of easy to remember words -- for the generation of deterministic wallets.

It consists of two parts: generating the mnenomic, and converting it into a

binary seed. This seed can be later used to generate deterministic wallets using

BIP-0032 or similar methods.

BIP Paper

---------

See https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki

for full specification

Installation

------------

To install this library and its dependencies use:

 ``pip install mnemonic``

Usage examples

--------------

Import library into python project via:

.. code-block:: python

   from mnemonic import Mnemonic

Initialize class instance, picking from available dictionaries:

- english

- chinese_simplified

- chinese_traditional

- french

- italian

- japanese

- korean

- spanish

- turkish

- czech

- portuguese

.. code-block:: python

   mnemo = Mnemonic(language)

   mnemo = Mnemonic("english")

Generate word list given the strength (128 - 256):

.. code-block:: python

   words = mnemo.generate(strength=256)

Given the word list and custom passphrase (empty in example), generate seed:

.. code-block:: python

   seed = mnemo.to_seed(words, passphrase="")

Given the word list, calculate original entropy:

.. code-block:: python

   entropy = mnemo.to_entropy(words)