1
0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-11-19 22:18:13 +00:00
Go to file
matejcik ed1c6867f2 build: do not compress source dist with XZ
because pypi doesn't support it
2018-12-06 16:40:22 +01:00
bash_completion.d cache autocompletion 2018-10-25 12:26:44 +02:00
docs docs: change "_" to "-" in command names 2018-12-05 16:56:12 +01:00
helper-scripts build: add script for fetching required release versions 2018-12-04 17:59:30 +01:00
tools updated helloworld.py (#343) 2018-12-03 16:09:52 +01:00
trezorlib trezorlib: set minimum firmware for TT to 2.0.10 2018-12-06 16:10:56 +01:00
vendor vendor: update trezor-common (adds timestamp field for Capricoin) 2018-10-25 12:51:43 +02:00
.gitignore build: remove prebuilt protobuf files 2018-07-09 13:46:18 +02:00
.gitmodules add submodule trezor-common 2018-04-10 15:58:34 +02:00
.travis.yml travis: workaround for python 3.7 2018-10-01 13:56:35 +02:00
AUTHORS regenerate license headers 2018-06-21 16:49:13 +02:00
CHANGELOG.md changelog: prepare for release & tagging 2018-12-06 16:12:31 +01:00
COPYING python-trezor is LGPLv3 2015-01-30 23:55:29 +01:00
Makefile build: apply make style to setup.py too 2018-09-03 15:45:34 +02:00
MANIFEST.in regenerate license headers 2018-06-21 16:49:13 +02:00
README.md readme: update markdown tables, add repology link 2018-07-11 01:09:38 +02:00
requirements-dev.txt tests: use stdlib mock instead of the third-party one 2018-10-10 13:15:28 +02:00
requirements-optional.txt build: drop rlp limitation for python<3.5 2018-10-01 14:04:40 +02:00
requirements.txt trezorlib: transport/protocol reshuffle 2018-11-12 12:22:26 +01:00
setup.cfg build: do not compress source dist with XZ 2018-12-06 16:40:22 +01:00
setup.py build: add typing_extensions requirement 2018-11-12 12:55:28 +01:00
shell.nix tests: fix style 2018-10-22 15:41:27 +02:00
tox.ini build: drop python<3.5 compatibility in CI and markers 2018-10-01 13:52:41 +02:00
trezorctl ui: smarter ClickUI prompts only once 2018-11-26 15:30:42 +01:00
trigger-travis.sh Merge branch 'master' into matejcik/refactor 2018-05-24 19:18:26 +02:00

python-trezor

image repology image

Python library and commandline client for communicating with TREZOR Hardware Wallet

See https://trezor.io for more information

Install

Python-trezor requires Python 3.3 or higher, and libusb 1.0. The easiest way to install it is with pip. The rest of this guide assumes you have a working pip; if not, you can refer to this guide.

Trezor T only

On a typical Linux / Mac / BSD system, you already have all you need. Install trezor with:

pip3 install --upgrade setuptools
pip3 install trezor

On Windows, you also need to install libusb and the appropriate drivers. This is, unfortunately, a topic bigger than this README.

Trezor One support

In addition to the above, you need to install development headers for HIDAPI.

On a Debian or Ubuntu based system, you can install these:

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

When installing the trezor library, you need to specify that you want hidapi:

pip3 install --upgrade setuptools
pip3 install trezor[hidapi]

Ethereum support

Ethereum requires additional python packages. Instead of pip3 install trezor, specify pip3 install trezor[ethereum].

You can combine it with the above, to get both HIDAPI and Ethereum support:

pip3 install trezor[ethereum,hidapi]

FreeBSD

On FreeBSD you can install the packages:

pkg install security/py-trezor

or build via ports:

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

Command line 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/ sub folder for detailed examples and options.

NOTE: An older version of the trezorctl command is available for Debian Stretch (and comes pre-installed on Tails OS).

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

Contributing

Python-trezor pulls coins info and protobuf messages from trezor-common repository. If you are developing new features for Trezor, you will want to start there. Once your changes are accepted to trezor-common, you can make a PR against this repository. Don't forget to update the submodule with:

git submodule update --init --remote

Then, rebuild the protobuf messages and get coins.json by running:

python3 setup.py prebuild

To get support for BTC-like coins, these steps are enough and no further changes to the library are necessary.