# python-keepkey

**Repository Path**: mirrors_zquestz/python-keepkey

## Basic Information

- **Project Name**: python-keepkey
- **Description**: KeepKey Python client
- **Primary Language**: Unknown
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-25
- **Last Updated**: 2025-09-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

.. image:: https://circleci.com/gh/keepkey/python-keepkey.svg?style=svg
    :target: https://circleci.com/gh/keepkey/python-keepkey

python-keepkey
==============

Client side implementation for KeepKey-compatible Bitcoin hardware wallets.

This is a modified version of python-trezor.  The changes made were to 
support KeepKey's protocol, as well as the additional feature set
of KeepKey.  For example, by default, device_recovery command invokes
KeepKey's style of device recovery using the Recovery Cipher.

See http://www.keepkey.com for more information.

Example
-------

also found in ``helloworld.py``

.. code:: python

  #!/usr/bin/env python

  from keepkeylib.client import KeepKeyClient
  from keepkeylib.transport_hid import HidTransport

  def main():
      # List all connected KeepKeys on USB
      devices = HidTransport.enumerate()

      # Check whether we found any
      if len(devices) == 0:
          print('No KeepKey found')
          return

      # Use first connected device
      transport = HidTransport(devices[0])

      # Creates object for manipulating KeepKey
      client = KeepKeyClient(transport)

      # Print out KeepKey's features and settings
      print(client.features)

      # Get the first address of first BIP44 account
      # (should be the same address as shown in KeepKey wallet Chrome extension)
      bip32_path = client.expand_path("44'/0'/0'/0/0")
      address = client.get_address('Bitcoin', bip32_path)
      print('Bitcoin address:', address)

      client.close()

  if __name__ == '__main__':
      main()

PIN Entering
------------

When you are asked for PIN, you have to enter scrambled PIN. Follow the numbers shown on KeepKey display and enter the their positions using the numeric keyboard mapping:

=== === ===
 7   8   9
 4   5   6
 1   2   3
=== === ===

Example: your PIN is **1234** and KeepKey is displaying the following:

=== === ===
 2   8   3
 5   4   6
 7   9   1
=== === ===

You have to enter: **3795**

How to install (virtualenv)
------------------------
* Install virtualenv
* Clone repository
* Run "virtualenv env" in the project root
* Run "source env/bin/activate"
* Run "pip install ."

How to install (Windows)
------------------------
* Install Python 2.7 (http://python.org)
* Run C:\\python27\\scripts\\pip.exe install cython
* Install Microsoft Visual C++ Compiler for Python 2.7
* Clone repository (using TortoiseGit) to local directory
* Run C:\\python27\\python.exe setup.py install (or develop)

How to install (Debian-Ubuntu)
------------------------------
* sudo apt-get install python-dev python-setuptools cython libusb-1.0-0-dev libudev-dev git
* git clone https://github.com/keepkey/python-keepkey.git
* cd python-keepkey
* pip install .

Running Tests
-------------

To run unit tests that don't require a device:

.. code:: shell

    $ python tests/unit/*.py

Release Process
---------------

* Check that the testsuite runs cleanly
* Bump the version in setup.py
* Tag the release
* Build the release
  * sudo python3 setup.py sdist bdist_wheel bdist_egg
* Upload the release
  * sudo python3 -m twine upload dist/* -s --sign-with gpg2

KeepKey Bridge
==============
The KeepKey Bridge is a standalone TCP-to-webusb bridge the KeepKey. It runs a python-keepkey client
based process that allows a localhost-based process to communicate with the KeepKey wallet, thus
bypassing the need for a webusb connection from a browser based platform.

The KeepKey Bridge is recommended only for advanced users who have problems connecting the KeepKey
on Windows.

Running the KeepKey Bridge
--------------------------
Download the KeepKey Bridge installer ``kkbsetup.exe`` for Windows in the release package here:

https://github.com/keepkey/python-keepkey/releases

When running the KeepKey Bridge, a blank cmd window with the title "KepKey Bridge" will be visible. 
To stop the bridge, simply close the cmd window.

Build for Windows
-----------------
Requirements:

- Windows 10
- python3
- waitress (python package)
- py2exe
- Inno Setup Compiler (optional, for creating Windows install exe)

From a command prompt terminal window, run
    ``python wbsetup.py py2exe -d windows/dist``

This will create a ``windows\dist`` folder with the Windows stand-alone executable file ``wait-serv.exe``

Inno Setup Compiler
-------------------
This tool builds and packages the executable for install on Windows. Build with the provided installer 
script (modify version, etc., as needed)

    ``windows/KeepKeyBridge.iss``

This will produce an executable install app

    ``windows/Output/kkbsetup.exe``