From 6b3f787fee0c155fa3bd7c0ecc3f7272280bb301 Mon Sep 17 00:00:00 2001
From: belikor <belikor@users.noreply.github.com>
Date: Wed, 7 Jul 2021 11:02:34 -0500
Subject: [PATCH 1/5] INSTALL.md: add more information on the virtual
 environments

Leave with `deactivate`.

Enter the environment again with
```
source lbry-venv/bin/activate
```

When developing, we can start the server interactively.
```
python lbry/extras/cli.py start
```

Parameters can be passed in the same way.
```
python lbry/extras/cli.py wallet balance
```

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.
```
ipdb lbry/extras/cli.py
```
---
 INSTALL.md | 35 +++++++++++++++++++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

diff --git a/INSTALL.md b/INSTALL.md
index b62d6e8286..e7bfe8f916 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -70,7 +70,10 @@ To install on Linux/Mac:
  $ make idea
  ```
 
-To verify your installation, `which lbrynet` should return a path inside of the `lbry-venv` folder created by the `python3.7 -m venv lbry-venv` command.
+To verify your installation, `which lbrynet` should return a path inside
+of the `lbry-venv` folder.
+
+To exit the virtual environment simply use the command `deactivate`.
 
 ### Windows
 
@@ -114,7 +117,35 @@ To run the unit and integration tests from the repo directory:
 ## Usage
 
 To start the API server:
-    `lbrynet start`
+```
+lbrynet start
+```
+
+Whenever the code inside [lbry-sdk/lbry](./lbry)
+is modified we should run `make install` to recompile the `lbrynet`
+executable with the newest code.
 
+## Development
+
+When developing, remember to enter the environment,
+and if you wish start the server interactively.
+```
+$ source lbry-venv/bin/activate
+
+(lbry-venv) $ python lbry/extras/cli.py start
+```
+
+Parameters can be passed in the same way.
+```
+(lbry-venv) $ python lbry/extras/cli.py wallet balance
+```
+
+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.
+```
+(lbry-venv) $ pip install ipdb
+
+(lbry-venv) $ ipdb lbry/extras/cli.py
+```
 
 Happy hacking!

From 90c24aade30ade9189bd612c3758afda022e0f05 Mon Sep 17 00:00:00 2001
From: belikor <belikor@users.noreply.github.com>
Date: Wed, 7 Jul 2021 13:23:08 -0500
Subject: [PATCH 2/5] INSTALL.md: using Python 3.8 does not work, issue #2769

Because of issue #2769 at the moment the `lbrynet` daemon
will only work correctly with Python 3.7.

The `deadsnakes` personal package archive (PPA) provides
Python 3.7 for Ubuntu distributions that no longer have it
in their official repositories like 18.04 and 20.04.

If Python 3.8+ is used, the daemon will start but the RPC server
may not accept messages, returning the following:
```
Could not connect to daemon. Are you sure it's running?
```
---
 INSTALL.md | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/INSTALL.md b/INSTALL.md
index e7bfe8f916..49c2cd3997 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -9,9 +9,17 @@ Here's a video walkthrough of this setup, which is itself hosted by the LBRY net
 
 ## Prerequisites
 
-Running `lbrynet` from source requires Python 3.7 or higher. Get the installer for your OS [here](https://www.python.org/downloads/release/python-370/).
+Running `lbrynet` from source requires Python 3.7. Get the installer for your OS [here](https://www.python.org/downloads/release/python-370/).
 
-After installing python 3, you'll need to install some additional libraries depending on your operating system.
+After installing Python 3.7, you'll need to install some additional libraries depending on your operating system.
+
+Because of [issue #2769](https://github.com/lbryio/lbry-sdk/issues/2769)
+at the moment the `lbrynet` daemon will only work correctly with Python 3.7.
+If Python 3.8+ is used, the daemon will start but the RPC server
+may not accept messages, returning the following:
+```
+Could not connect to daemon. Are you sure it's running?
+```
 
 ### macOS
 
@@ -31,7 +39,7 @@ Assistance installing Python3: https://docs.python-guide.org/starting/install3/o
 
 ### Linux
 
-On Ubuntu (16.04 minimum, we recommend 18.04), install the following:
+On Ubuntu (we recommend 18.04 or 20.04), install the following:
 
 ```
 sudo add-apt-repository ppa:deadsnakes/ppa
@@ -39,6 +47,10 @@ sudo apt-get update
 sudo apt-get install build-essential python3.7 python3.7-dev git python3.7-venv libssl-dev python-protobuf
 ```
 
+The `deadsnakes` personal package archive (PPA) provides Python 3.7
+for those Ubuntu distributions that no longer have it in their
+official repositories.
+
 On Raspbian, you will also need to install `python-pyparsing`.
 
 If you're running another Linux distro, install the equivalent of the above packages for your system.

From 8ce61fbd5260bf57362f86889caae2fae36981c7 Mon Sep 17 00:00:00 2001
From: belikor <belikor@users.noreply.github.com>
Date: Sun, 11 Jul 2021 17:57:36 -0500
Subject: [PATCH 3/5] INSTALL.md: break the big blocks of code, and remove the
 space

Remove the first space in the block of code as it is not necessary.

This
 ```
 $ python --version
 ```

Becomes this
```
$ python --version
```

Also break the big block of code into individual blocks.
---
 INSTALL.md | 98 +++++++++++++++++++++++++++++++-----------------------
 1 file changed, 56 insertions(+), 42 deletions(-)

diff --git a/INSTALL.md b/INSTALL.md
index 49c2cd3997..76bb22c9da 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -26,11 +26,12 @@ Could not connect to daemon. Are you sure it's running?
 macOS users will need to install [xcode command line tools](https://developer.xamarin.com/guides/testcloud/calabash/configuring/osx/install-xcode-command-line-tools/) and [homebrew](http://brew.sh/).
 
 These environment variables also need to be set:
-1. PYTHONUNBUFFERED=1
-2. EVENT_NOKQUEUE=1
+```
+PYTHONUNBUFFERED=1
+EVENT_NOKQUEUE=1
+```
 
 Remaining dependencies can then be installed by running:
-
 ```
 brew install python protobuf
 ```
@@ -40,7 +41,6 @@ Assistance installing Python3: https://docs.python-guide.org/starting/install3/o
 ### Linux
 
 On Ubuntu (we recommend 18.04 or 20.04), install the following:
-
 ```
 sudo add-apt-repository ppa:deadsnakes/ppa
 sudo apt-get update
@@ -59,52 +59,68 @@ If you're running another Linux distro, install the equivalent of the above pack
 
 ### Linux/Mac
 
-To install on Linux/Mac:
+Clone the repository:
+```
+$ git clone https://github.com/lbryio/lbry-sdk.git
+$ cd lbry-sdk
+```
+
+Create a Python virtual environment for lbry-sdk:
+```
+$ python3.7 -m venv lbry-venv
+```
 
- ```
- Clone the repository:
- $ git clone https://github.com/lbryio/lbry-sdk.git
- $ cd lbry-sdk
+Activate virtual environment:
+```
+$ source lbry-venv/bin/activate
+```
 
- Create a Python virtual environment for lbry-sdk:
- $ python3.7 -m venv lbry-venv
- 
- Activating lbry-sdk virtual environment:
- $ source lbry-venv/bin/activate
- 
- Make sure you're on Python 3.7+ (as the default Python in virtual environment):
- $ python --version
+Make sure you're on Python 3.7+ as default in the virtual environment:
+```
+$ python --version
+```
 
- Install packages:
- $ make install
+Install packages:
+```
+$ make install
+```
 
- If you are on Linux and using PyCharm, generates initial configs:
- $ make idea
- ```
+If you are on Linux and using PyCharm, generates initial configs:
+```
+$ make idea
+```
 
 To verify your installation, `which lbrynet` should return a path inside
 of the `lbry-venv` folder.
+```
+(lbry-venv) $ which lbrynet
+/opt/lbry-sdk/lbry-venv/bin/lbrynet
+```
 
 To exit the virtual environment simply use the command `deactivate`.
 
 ### Windows
 
-To install on Windows:
-
- ```
- Clone the repository:
- > git clone https://github.com/lbryio/lbry-sdk.git
- > cd lbry-sdk
+Clone the repository:
+```
+> git clone https://github.com/lbryio/lbry-sdk.git
+> cd lbry-sdk
+```
 
- Create a Python virtual environment for lbry-sdk:
- > python -m venv lbry-venv
+Create a Python virtual environment for lbry-sdk:
+```
+> python -m venv lbry-venv
+```
 
- Activating lbry-sdk virtual environment:
- > lbry-venv\Scripts\activate
+Activate virtual environment:
+```
+> lbry-venv\Scripts\activate
+```
 
- Install packages:
- > pip install -e .
- ```
+Install packages:
+```
+> pip install -e .
+```
 
 ## Run the tests
 ### Elasticsearch
@@ -115,16 +131,14 @@ The easiest way to start it is using docker with:
 ```bash
 make elastic-docker
 ```
-Alternative installation methods are available [at Elasticsearch website](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html).
-
 
+Alternative installation methods are available [at Elasticsearch website](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html).
 
 To run the unit and integration tests from the repo directory:
-
- ```
- python -m unittest discover tests.unit
- python -m unittest discover tests.integration
- ```
+```
+python -m unittest discover tests.unit
+python -m unittest discover tests.integration
+```
 
 ## Usage
 

From e47f737a2f86538f27850d62afaa3cb891da11c5 Mon Sep 17 00:00:00 2001
From: Alex Grin <lyoshenka@users.noreply.github.com>
Date: Mon, 19 Jul 2021 14:15:21 -0400
Subject: [PATCH 4/5] Update INSTALL.md

---
 INSTALL.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/INSTALL.md b/INSTALL.md
index 76bb22c9da..c091a8dad7 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -47,7 +47,7 @@ sudo apt-get update
 sudo apt-get install build-essential python3.7 python3.7-dev git python3.7-venv libssl-dev python-protobuf
 ```
 
-The `deadsnakes` personal package archive (PPA) provides Python 3.7
+The [deadsnakes PPA](https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa) provides Python 3.7
 for those Ubuntu distributions that no longer have it in their
 official repositories.
 

From 35ec4eec52f20d341111908daca671db8194ad7a Mon Sep 17 00:00:00 2001
From: Alex Grin <lyoshenka@users.noreply.github.com>
Date: Mon, 19 Jul 2021 14:20:15 -0400
Subject: [PATCH 5/5] Update INSTALL.md

---
 INSTALL.md | 52 ++++++++++++++++++++++++++--------------------------
 1 file changed, 26 insertions(+), 26 deletions(-)

diff --git a/INSTALL.md b/INSTALL.md
index c091a8dad7..84e7bda2db 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -60,39 +60,39 @@ If you're running another Linux distro, install the equivalent of the above pack
 ### Linux/Mac
 
 Clone the repository:
-```
-$ git clone https://github.com/lbryio/lbry-sdk.git
-$ cd lbry-sdk
+```bash
+git clone https://github.com/lbryio/lbry-sdk.git
+cd lbry-sdk
 ```
 
 Create a Python virtual environment for lbry-sdk:
-```
-$ python3.7 -m venv lbry-venv
+```bash
+python3.7 -m venv lbry-venv
 ```
 
 Activate virtual environment:
-```
-$ source lbry-venv/bin/activate
+```bash
+source lbry-venv/bin/activate
 ```
 
 Make sure you're on Python 3.7+ as default in the virtual environment:
-```
-$ python --version
+```bash
+python --version
 ```
 
 Install packages:
-```
-$ make install
+```bash
+make install
 ```
 
 If you are on Linux and using PyCharm, generates initial configs:
-```
-$ make idea
+```bash
+make idea
 ```
 
 To verify your installation, `which lbrynet` should return a path inside
 of the `lbry-venv` folder.
-```
+```bash
 (lbry-venv) $ which lbrynet
 /opt/lbry-sdk/lbry-venv/bin/lbrynet
 ```
@@ -102,24 +102,24 @@ To exit the virtual environment simply use the command `deactivate`.
 ### Windows
 
 Clone the repository:
-```
-> git clone https://github.com/lbryio/lbry-sdk.git
-> cd lbry-sdk
+```bash
+git clone https://github.com/lbryio/lbry-sdk.git
+cd lbry-sdk
 ```
 
 Create a Python virtual environment for lbry-sdk:
-```
-> python -m venv lbry-venv
+```bash
+python -m venv lbry-venv
 ```
 
 Activate virtual environment:
-```
-> lbry-venv\Scripts\activate
+```bash
+lbry-venv\Scripts\activate
 ```
 
 Install packages:
-```
-> pip install -e .
+```bash
+pip install -e .
 ```
 
 ## Run the tests
@@ -155,20 +155,20 @@ executable with the newest code.
 
 When developing, remember to enter the environment,
 and if you wish start the server interactively.
-```
+```bash
 $ source lbry-venv/bin/activate
 
 (lbry-venv) $ python lbry/extras/cli.py start
 ```
 
 Parameters can be passed in the same way.
-```
+```bash
 (lbry-venv) $ python lbry/extras/cli.py wallet balance
 ```
 
 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.
-```
+```bash
 (lbry-venv) $ pip install ipdb
 
 (lbry-venv) $ ipdb lbry/extras/cli.py