forked from LBRYCommunity/lbry-sdk
Update INSTALL.md
This commit is contained in:
parent
e47f737a2f
commit
35ec4eec52
1 changed files with 26 additions and 26 deletions
52
INSTALL.md
52
INSTALL.md
|
@ -60,39 +60,39 @@ If you're running another Linux distro, install the equivalent of the above pack
|
||||||
### Linux/Mac
|
### Linux/Mac
|
||||||
|
|
||||||
Clone the repository:
|
Clone the repository:
|
||||||
```
|
```bash
|
||||||
$ git clone https://github.com/lbryio/lbry-sdk.git
|
git clone https://github.com/lbryio/lbry-sdk.git
|
||||||
$ cd lbry-sdk
|
cd lbry-sdk
|
||||||
```
|
```
|
||||||
|
|
||||||
Create a Python virtual environment for lbry-sdk:
|
Create a Python virtual environment for lbry-sdk:
|
||||||
```
|
```bash
|
||||||
$ python3.7 -m venv lbry-venv
|
python3.7 -m venv lbry-venv
|
||||||
```
|
```
|
||||||
|
|
||||||
Activate virtual environment:
|
Activate virtual environment:
|
||||||
```
|
```bash
|
||||||
$ source lbry-venv/bin/activate
|
source lbry-venv/bin/activate
|
||||||
```
|
```
|
||||||
|
|
||||||
Make sure you're on Python 3.7+ as default in the virtual environment:
|
Make sure you're on Python 3.7+ as default in the virtual environment:
|
||||||
```
|
```bash
|
||||||
$ python --version
|
python --version
|
||||||
```
|
```
|
||||||
|
|
||||||
Install packages:
|
Install packages:
|
||||||
```
|
```bash
|
||||||
$ make install
|
make install
|
||||||
```
|
```
|
||||||
|
|
||||||
If you are on Linux and using PyCharm, generates initial configs:
|
If you are on Linux and using PyCharm, generates initial configs:
|
||||||
```
|
```bash
|
||||||
$ make idea
|
make idea
|
||||||
```
|
```
|
||||||
|
|
||||||
To verify your installation, `which lbrynet` should return a path inside
|
To verify your installation, `which lbrynet` should return a path inside
|
||||||
of the `lbry-venv` folder.
|
of the `lbry-venv` folder.
|
||||||
```
|
```bash
|
||||||
(lbry-venv) $ which lbrynet
|
(lbry-venv) $ which lbrynet
|
||||||
/opt/lbry-sdk/lbry-venv/bin/lbrynet
|
/opt/lbry-sdk/lbry-venv/bin/lbrynet
|
||||||
```
|
```
|
||||||
|
@ -102,24 +102,24 @@ To exit the virtual environment simply use the command `deactivate`.
|
||||||
### Windows
|
### Windows
|
||||||
|
|
||||||
Clone the repository:
|
Clone the repository:
|
||||||
```
|
```bash
|
||||||
> git clone https://github.com/lbryio/lbry-sdk.git
|
git clone https://github.com/lbryio/lbry-sdk.git
|
||||||
> cd lbry-sdk
|
cd lbry-sdk
|
||||||
```
|
```
|
||||||
|
|
||||||
Create a Python virtual environment for lbry-sdk:
|
Create a Python virtual environment for lbry-sdk:
|
||||||
```
|
```bash
|
||||||
> python -m venv lbry-venv
|
python -m venv lbry-venv
|
||||||
```
|
```
|
||||||
|
|
||||||
Activate virtual environment:
|
Activate virtual environment:
|
||||||
```
|
```bash
|
||||||
> lbry-venv\Scripts\activate
|
lbry-venv\Scripts\activate
|
||||||
```
|
```
|
||||||
|
|
||||||
Install packages:
|
Install packages:
|
||||||
```
|
```bash
|
||||||
> pip install -e .
|
pip install -e .
|
||||||
```
|
```
|
||||||
|
|
||||||
## Run the tests
|
## Run the tests
|
||||||
|
@ -155,20 +155,20 @@ executable with the newest code.
|
||||||
|
|
||||||
When developing, remember to enter the environment,
|
When developing, remember to enter the environment,
|
||||||
and if you wish start the server interactively.
|
and if you wish start the server interactively.
|
||||||
```
|
```bash
|
||||||
$ source lbry-venv/bin/activate
|
$ source lbry-venv/bin/activate
|
||||||
|
|
||||||
(lbry-venv) $ python lbry/extras/cli.py start
|
(lbry-venv) $ python lbry/extras/cli.py start
|
||||||
```
|
```
|
||||||
|
|
||||||
Parameters can be passed in the same way.
|
Parameters can be passed in the same way.
|
||||||
```
|
```bash
|
||||||
(lbry-venv) $ python lbry/extras/cli.py wallet balance
|
(lbry-venv) $ python lbry/extras/cli.py wallet balance
|
||||||
```
|
```
|
||||||
|
|
||||||
If a Python debugger (`pdb` or `ipdb`) is installed we can also start it
|
If a Python debugger (`pdb` or `ipdb`) is installed we can also start it
|
||||||
in this way, set up break points, and step through the code.
|
in this way, set up break points, and step through the code.
|
||||||
```
|
```bash
|
||||||
(lbry-venv) $ pip install ipdb
|
(lbry-venv) $ pip install ipdb
|
||||||
|
|
||||||
(lbry-venv) $ ipdb lbry/extras/cli.py
|
(lbry-venv) $ ipdb lbry/extras/cli.py
|
||||||
|
|
Loading…
Reference in a new issue