Skip to content
Electrum; Bitcoin thin client
Branch: master
Clone or download
Pull request Compare This branch is 1639 commits behind spesmilo: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.
.github
contrib
gui
icons Replace icon for local tx Feb 27, 2018
lib
plugins
pubkeys
scripts
snap
.gitignore
.travis.yml
AUTHORS
Info.plist
LICENCE
MANIFEST.in remove themes, check python3 in setup.py Oct 18, 2015
README.rst
RELEASE-NOTES
app.fil updates for i18n translations Aug 1, 2016
electrum
electrum-env
electrum.conf.sample
electrum.desktop
electrum.icns
icons.qrc
setup.py
tox.ini

README.rst

Electrum - Lightweight Bitcoin client

Licence: MIT Licence
Author: Thomas Voegtlin
Language: Python
Homepage: https://electrum.org/
Build Status Test coverage statistics

Getting started

Electrum is a pure python application. If you want to use the Qt interface, install the Qt dependencies:

sudo apt-get install python3-pyqt5

If you downloaded the official package (tar.gz), you can run Electrum from its root directory, without installing it on your system; all the python dependencies are included in the 'packages' directory. To run Electrum from its root directory, just do:

./electrum

You can also install Electrum on your system, by running this command:

sudo apt-get install python3-setuptools
python3 setup.py install

This will download and install the Python dependencies used by Electrum, instead of using the 'packages' directory.

If you cloned the git repository, you need to compile extra files before you can run Electrum. Read the next section, "Development Version".

Development version

Check out the code from Github:

git clone git://github.com/spesmilo/electrum.git
cd electrum

Run install (this should install dependencies):

python3 setup.py install

Compile the icons file for Qt:

sudo apt-get install pyqt5-dev-tools
pyrcc5 icons.qrc -o gui/qt/icons_rc.py

Compile the protobuf description file:

sudo apt-get install protobuf-compiler
protoc --proto_path=lib/ --python_out=lib/ lib/paymentrequest.proto

Create translations (optional):

sudo apt-get install python-requests gettext
./contrib/make_locale

Creating Binaries

To create binaries, create the 'packages' directory:

./contrib/make_packages

This directory contains the python dependencies used by Electrum.

Mac OS X / macOS

See contrib/build-osx/.

Windows

See contrib/build-wine/.

Android

See gui/kivy/Readme.txt file.

You can’t perform that action at this time.