Skip to content
Electrum; Bitcoin thin client
Python Shell NSIS Java Dockerfile Makefile
Branch: master
Clone or download
Pull request Compare This branch is 49 commits ahead, 1638 commits behind spesmilo:master.
Latest commit bcd774d Feb 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
contrib lpos functions Feb 9, 2019
electrum lpos functions Feb 9, 2019
icons Added NIX official server Nov 26, 2018
pubkeys Nixification Nov 8, 2018
snap Nixification Nov 8, 2018
.gitignore Cherry pick commits Nov 26, 2018
.gitmodules Nixification Nov 25, 2018
.travis.yml Nixification Nov 8, 2018
AUTHORS Nixification Nov 8, 2018
LICENCE Nixification Nov 8, 2018
MANIFEST.in Nixification Nov 8, 2018
README.rst Nixification Nov 13, 2018
RELEASE-NOTES Nixification Nov 8, 2018
electrum-env readme: use 'python3 -m pip install' to install Oct 12, 2018
electrum.desktop Fiat conversion Nov 24, 2018
electrum.icns Changes to build file and NIX icon Nov 16, 2018
icons.qrc Nixification Nov 8, 2018
run_electrum Nixification Nov 13, 2018
setup.py Merge branch 'master' into pr/1 Nov 16, 2018
tox.ini Nixification Nov 8, 2018

README.rst

Electrum - Lightweight NIX client

Licence: MIT Licence
Author: Thomas Voegtlin
Language: Python (>= 3.6)
Homepage: https://electrum.org/
Build Status Test coverage statistics Help translate Electrum online

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:

./run_electrum

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

sudo apt-get install python3-setuptools
python3 -m pip install .[fast]

This will download and install the Python dependencies used by Electrum, instead of using the 'packages' directory. The 'fast' extra contains some optional dependencies that we think are often useful but they are not strictly needed.

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 -m pip install .[fast]

Render the SVG icons to PNGs (optional):

for i in lock unlock confirmed status_lagging status_disconnected status_connected_proxy status_connected status_waiting preferences; do convert -background none icons/$i.svg icons/$i.png; done

Compile the icons file for Qt:

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

Compile the protobuf description file:

sudo apt-get install protobuf-compiler
protoc --proto_path=electrum --python_out=electrum electrum/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 electrum/gui/kivy/Readme.md file.

You can’t perform that action at this time.