trezor-firmware

mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-16 11:28:14 +00:00

Go to file

Tomas Susanka d6f0c54d3e tests: CallException relaced with AssertionException in response validation Generic exceptions are evil. When throwing a CallException in the request check you can't distinguish in the tests if it is an Exception that occured in during the execution (that's CallException) or during some tests (that used to be CallException as well).		2018-02-22 16:51:34 +01:00
bash_completion.d	add initial bash_completion script	2016-06-22 17:26:11 +02:00
docs	Improve / simplify documentation	2017-12-07 21:57:23 +01:00
tools	chmod +x tools/mem_flashblock.py	2018-02-21 16:48:40 +01:00
trezorlib	tests: CallException relaced with AssertionException in response validation	2018-02-22 16:51:34 +01:00
.flake8	fix flake8 warning	2017-12-23 22:13:09 +01:00
.gitignore	Transaction signing example and explanation	2017-12-02 17:36:13 +01:00
.travis.yml	use click in trezorctl	2017-07-05 12:55:38 +02:00
COPYING	python-trezor is LGPLv3	2015-01-30 23:55:29 +01:00
MANIFEST.in	tests: Move to trezorlib.tests	2017-12-19 13:16:22 +01:00
README.rst	Use python3 in README	2018-02-02 16:34:30 +01:00
requirements.txt	setup: add dependency for libusb1	2018-02-02 01:22:16 +01:00
setup.py	Use python3 for setup	2018-02-02 16:36:29 +01:00
tox.ini	tox: Run trezorlib.tests.unit_tests	2017-12-19 13:16:22 +01:00
trezorctl	Introducing TrezorDevice, removing concept of transports from trezorctl	2018-02-02 18:29:20 +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

Python library and commandline client for communicating with TREZOR Hardware Wallet

See https://trezor.io for more information

Install
-------

Linux requirements:

.. code::

  sudo apt-get install python3-dev cython3 libusb-1.0-0-dev libudev-dev git

Linux & Mac Python requirements:

.. code::

  sudo -H pip3 install setuptools
  sudo -H pip3 install -r requirements.txt
  sudo -H pip3 install trezor

On FreeBSD you can install the packages:

.. code::

  pkg install security/py-trezor

or build via ports:

.. code::

  cd /usr/ports/security/py-trezor
  make install clean


Commandline client (trezorctl)
---------------------------

The included ``trezorctl`` python script can perform various tasks such as changing setting in the Trezor, signing transactions, retrieving account info and addresses. See the `docs/ <docs/>`_ sub folder for detailed examples and options.

NOTE: An older version of the ``trezorctl`` command is `available for Debian Stretch <https://packages.debian.org/en/stretch/python-trezor>`_ (and comes pre-installed on `Tails OS <https://tails.boum.org/>`_).


Python Library
--------------

You can use this python library to interact with a Bitcoin Trezor and use its capabilities in your application.
See examples here in the `tools/ <tools/>`_ sub folder.


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**