1
0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-22 22:38:08 +00:00
Go to file
matejcik 54f1599a5a regenerate license headers
This clarifies the intent: the project is licenced under terms
of LGPL version 3 only, but the standard headers cover only "3 or later",
so we had to rewrite them.

In the same step, we removed author information from individual files
in favor of "SatoshiLabs and contributors", and include an AUTHORS
file that lists the contributors.

Apologies to those whose names are missing; please contact us if you wish
to add your info to the AUTHORS file.
2018-06-21 16:49:13 +02: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 remove remaining usages of expand_path 2018-05-28 15:47:57 +02:00
trezorlib regenerate license headers 2018-06-21 16:49:13 +02:00
vendor trezorctl/trezorlib: add show_display to StellarGetAddress/StellarGetPublicKey 2018-06-11 18:55:52 +02:00
.flake8 flake8: be stricter 2018-05-11 15:29:38 +02:00
.gitignore gitignore more files 2018-06-07 14:01:52 +02:00
.gitmodules add submodule trezor-common 2018-04-10 15:58:34 +02:00
.travis.yml travis: set virtualenv version to restore build on py33 2018-05-18 10:58:28 +02:00
AUTHORS regenerate license headers 2018-06-21 16:49:13 +02:00
CHANGELOG.md changelog: include stellar additions that are also unreleased 2018-06-18 18:46:31 +02:00
COPYING python-trezor is LGPLv3 2015-01-30 23:55:29 +01:00
MANIFEST.in regenerate license headers 2018-06-21 16:49:13 +02:00
README.md release: convert README to markdown and include it in long_description 2018-06-19 16:54:54 +02:00
requirements-dev.txt build: add flake8 to dev requirements 2018-05-04 17:50:49 +02:00
requirements-optional.txt build: move ethereum requirements to their own extra 2018-05-07 13:05:48 +02:00
requirements.txt build: require typing module for python < 3.4 2018-05-09 17:43:41 +02:00
setup.py regenerate license headers 2018-06-21 16:49:13 +02:00
tox.ini transport: fix all_transports when required modules are missing (#232) 2018-03-09 10:58:24 +01:00
trezorctl trezorctl: drop list_coins command (closes #277) 2018-06-18 18:43:10 +02:00
trigger-travis.sh Merge branch 'master' into matejcik/refactor 2018-05-24 19:18:26 +02:00

python-trezor

image

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:

789
456
123

Example: your PIN is 1234 and TREZOR is displaying the following:

283
546
791

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.