Skip to content
🐍 Client side implementation for TREZOR-compatible Bitcoin hardware wallets.
Branch: master
Clone or download
Pull request Compare This branch is 461 commits behind trezor:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bash_completion.d
docs
tools
trezorlib
vendor
.flake8
.gitignore
.gitmodules
.travis.yml
CHANGELOG.md
COPYING
MANIFEST.in
README.rst
requirements-dev.txt
requirements-optional.txt
requirements.txt
setup.py
tox.ini
trezorctl
trigger-travis.sh

README.rst

python-trezor

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

Python library and commandline client for communicating with TREZOR Hardware Wallet

See https://trezor.io for more information

Install

Linux requirements:

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

Linux & Mac Python requirements:

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

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

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

You can’t perform that action at this time.