@@ -18,21 +18,62 @@ _(If you've come here looking to simply run Electrum,
18
18
[ you may download it here] ( https://electrum.org/#download ) .)_
19
19
20
20
Electrum itself is pure Python, and so are most of the required dependencies,
21
- but not everything. The following sections describe how to run from source, but here
22
- is a TL;DR:
21
+ but not everything. The following sections describe how to run from tar.gz or from source.
22
+
23
+ ### Running from tar.gz
24
+
25
+ If you downloaded the official package (tar.gz), you can run
26
+ Electrum from its root directory without installing it on your
27
+ system; all the pure python dependencies are included in the 'packages'
28
+ directory. You will need to install a few system dependencies:
29
+
30
+ To use the desktop GUI (Qt5):
23
31
24
32
```
25
- $ sudo apt-get install libsecp256k1-dev
26
- $ python3 -m pip install --user ".[gui,crypto]"
33
+ $ sudo apt-get install python3-pyqt5
27
34
```
28
35
29
- ### Not pure-python dependencies
36
+ Due to the need for fast symmetric ciphers,
37
+ [ cryptography] ( https://github.com/pyca/cryptography ) is required.
38
+ Install from your package manager:
39
+ ```
40
+ $ sudo apt-get install python3-cryptography
41
+ ```
30
42
31
- If you want to use the Qt interface, install the Qt dependencies :
43
+ To run Electrum from its root directory, just do :
32
44
```
33
- $ sudo apt-get install python3-pyqt5
45
+ $ ./run_electrum
46
+ ```
47
+
48
+ This method currently lacks hardware wallet support.
49
+ If you need hardware wallet support, you should install as [ described below] ( #install-to-a-python-virtualenv )
50
+
51
+
52
+ ### Install to a python virtualenv
53
+
54
+ #### Create a python virtualenv
55
+
56
+ ``` commandline
57
+ $ python3 -m venv $HOME/electrum
58
+ ```
59
+
60
+ When the ` virtualenv ` is created or already exists, activate it:
61
+
62
+ ``` commandline
63
+ $ . $HOME/electrum/bin/activate
34
64
```
35
65
66
+ #### Install electrum and dependencies
67
+
68
+ ``` commandline
69
+ $ pip install .[gui,crypto,hardware]
70
+ ```
71
+
72
+ This will install Electrum and all required dependencies,
73
+ including for Qt desktop GUI and hardware wallets.
74
+
75
+ #### Not pure-python dependencies
76
+
36
77
For elliptic curve operations,
37
78
[ libsecp256k1] ( https://github.com/bitcoin-core/secp256k1 )
38
79
is a required dependency:
@@ -47,54 +88,42 @@ $ sudo apt-get install automake libtool
47
88
$ ./contrib/make_libsecp256k1.sh
48
89
```
49
90
50
- Due to the need for fast symmetric ciphers,
51
- [ cryptography] ( https://github.com/pyca/cryptography ) is required.
52
- Install from your package manager (or from pip):
53
- ```
54
- $ sudo apt-get install python3-cryptography
55
- ```
56
-
57
- If you would like hardware wallet support,
91
+ For more information about hardware wallet dependencies,
58
92
[ see this] ( https://github.com/spesmilo/electrum-docs/blob/master/hardware-linux.rst ) .
59
93
60
-
61
- ### Running from tar.gz
62
-
63
- If you downloaded the official package (tar.gz), you can run
64
- Electrum from its root directory without installing it on your
65
- system; all the pure python dependencies are included in the 'packages'
66
- directory. To run Electrum from its root directory, just do:
67
- ```
68
- $ ./run_electrum
94
+ To run Electrum, just do:
69
95
```
70
-
71
- You can also install Electrum on your system, by running this command:
72
- ```
73
- $ sudo apt-get install python3-setuptools python3-pip
74
- $ python3 -m pip install --user .
96
+ $ electrum
75
97
```
76
98
77
- This will download and install the Python dependencies used by
78
- Electrum instead of using the 'packages' directory.
79
- It will also place an executable named ` electrum ` in ` ~/.local/bin ` ,
80
- so make sure that is on your ` PATH ` variable.
99
+ Or, without first activating the ` virtualenv ` :
81
100
101
+ ``` commandline
102
+ $ $HOME/electrum/bin/electrum
103
+ ```
82
104
83
105
### Development version (git clone)
84
106
85
107
_ (For OS-specific instructions, see [ here for Windows] ( contrib/build-wine/README_windows.md ) ,
86
108
and [ for macOS] ( contrib/osx/README_macos.md ) )_
87
109
88
- Check out the code from GitHub:
110
+ #### Check out the code from GitHub:
89
111
```
90
112
$ git clone https://github.com/spesmilo/electrum.git
91
113
$ cd electrum
92
114
$ git submodule update --init
93
115
```
94
116
95
- Run install (this should install dependencies):
117
+ #### create and activate virtualenv
118
+
119
+ ``` commandline
120
+ $ python3 -m venv $HOME/electrum
121
+ $ . $HOME/electrum/bin/activate
122
+ ```
123
+
124
+ #### Run install (this should install dependencies):
96
125
```
97
- $ python3 -m pip install --user - e .
126
+ $ pip install -e .[gui,crypto,hardware]
98
127
```
99
128
100
129
Create translations (optional):
0 commit comments