Go to file
Pavol Rusnak d2b8f51a07
add initial bash_completion script
2016-06-22 17:26:11 +02:00
bash_completion.d add initial bash_completion script 2016-06-22 17:26:11 +02:00
tests fix pylint warnings 2016-05-26 17:20:44 +02:00
tools whitespace 2016-06-22 14:51:46 +02:00
trezorlib update protobuf 2016-06-21 12:22:39 +02:00
.gitignore remove images 2015-05-07 18:29:38 +02:00
.travis.yml drop python 2.6 and older, 3.3 and older 2016-02-18 11:19:15 +01:00
COPYING python-trezor is LGPLv3 2015-01-30 23:55:29 +01:00
MANIFEST.in Include tests in release source tarball 2016-04-25 07:23:59 +01:00
README.rst update install section 2016-06-09 16:39:10 +02:00
build_pb.sh cleanup protobuf mess 2013-12-16 17:40:25 +01:00
cmdtr.py rename cmdtr.py to trezorctl (but keep symlink for now) 2015-02-22 14:23:39 +01:00
helloworld.py import print function from future 2016-05-20 22:27:20 +02:00
mnemonic_check.py fix pylint warnings 2016-05-26 17:20:44 +02:00
setup.py update setup.py to also accept protobuf 3.x 2016-05-05 20:33:49 +02:00
signtest.py use env for python 2016-05-24 20:47:57 +02:00
trezorctl Merge pull request #62 from Arachnid/ethereum_send_tx 2016-05-27 20:49:21 +02:00
trezorctl-emu.sh rename cmdtr.py to trezorctl (but keep symlink for now) 2015-02-22 14:23:39 +01:00

README.rst

python-trezor
=============

.. image:: https://travis-ci.org/trezor/python-trezor.svg?branch=master
    :target: https://travis-ci.org/trezor/python-trezor

.. image:: https://badges.gitter.im/trezor/community.svg
    :target: https://gitter.im/trezor/community

Client side implementation for TREZOR-compatible Bitcoin hardware wallets.

See http://bitcointrezor.com for more information.

Example
-------

also found in ``helloworld.py``

.. code:: python

  #!/usr/bin/env python

  from trezorlib.client import TrezorClient
  from trezorlib.transport_hid import HidTransport

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

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

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

      # Creates object for manipulating TREZOR
      client = TrezorClient(transport)

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

      # Get the first address of first BIP44 account
      # (should be the same address as shown in mytrezor.com)
      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 TREZOR 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 TREZOR is displaying the following:

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

You have to enter: **3795**

Install
-------

(Run with sudo if not running in superuser mode)

.. code::

  pip install trezor

How to install from source (Windows)
------------------------------------
* Install Python 2.7 (http://python.org)
* Install Cython (Windows binaries on http://cython.org/#download)
* Install Microsoft Visual Studio 2008 Express
* Add "C:\\Program Files (x86)\\Microsoft Visual Studio 9.0" to system PATH
* Clone repository (using TortoiseGit) to local directory
* Run C:\\python27\\python.exe setup.py install (or develop)

How to install from source (Debian/Ubuntu)
------------------------------------------
* sudo apt-get install python-dev python-setuptools cython libusb-1.0-0-dev libudev-dev git
* git clone https://github.com/trezor/python-trezor.git
* cd python-trezor
* python setup.py install (or develop)