Installing LBRY

If only the json-rpc API server is needed the recommended way to install LBRY is to use a pre-built binary. We provide binaries for all major operating systems. See the README.

These instructions are for installing LBRY from source, which is recommended if you are interested in doing development work or LBRY is not available on your operating system (godspeed, TempleOS users).

Prerequisites

Before starting, you'll need to install some additional libraries depending on your operating system.

Python

Running lbrynet from source requires Python 3.7

OS X Prerequisites

Install xcode command line tools and homebrew.

Remaining dependencies can then be installed by running:

brew install mpfr libmpc protobuf
sudo easy_install pip
sudo pip install virtualenv

Linux Prerequisites

On Ubuntu (we recommend 16.04), install the following:

sudo apt-get install build-essential python3.7 python3.7-dev git python-virtualenv libssl-dev python-protobuf

On Raspbian, you will also need to install python-pyparsing.

If you're running another Linux flavor, install the equivalent of the above packages for your system.

Windows Prerequisites

Install mingw32 base and c++ compiler.

Add C:\MinGW\bin to the windows PATH.

Enable distutils to compile with mingw32 by creating a distutils.cfg file in PYTHONPATH\Lib\distutils containing:

[build]
compiler = mingw32

If using virtualenv, which is recommended, copy the PYTHONPATH\Lib\distutils directory to the virtualenv.

It's recommended to use Unofficial Windows Binaries for Python Extension Packages for as many of the required packages as possible. Currently, available binaries include:

Twisted
Zope.interface
pywin32

Install the above binaries with pip install *.whl

Install pywin32 system files by run python.exe Scripts\pywin32_postinstall.py -install from an elevated command prompt.

Finally, you'll need miniupnpc. Download the source and compile with MinGW by running mingw32make.bat. Then install the module by running python setupmingw32.py install.

Installation

To install:

git clone https://github.com/lbryio/lbry.git
cd lbry

virtualenv lbry-venv --python=python3.7
source lbry-venv/bin/activate

python --version # Python 2 is not supported. Make sure you're on Python 3.7

pip install --editable .[test]  # [test] installs extras needed for running the tests

To run the unit tests from the repo directory:

trial --reactor=asyncio tests.unit

To start the API server: lbrynet start

To verify your install, which lbrynet should return a path inside of the lbry-venv folder created by the virtualenv command.

Making a Change

If you are not already inside the virtual environment, run:

source lbry-venv/bin/activate

Then run:

pip install --editable .

This will install lbrynet in such a way that the changes you make to the code will be used as soon as you restart the API server.

Happy hacking!

3.3 KiB Raw Blame History