Development setup

Requirements

It is required that you have pip, python (version 3.5 or greater) and git installed.

Python environment setup

In general, it is recommended to use a virtual environment to separate your global python application from the environment (all the dependency-packages) µRaiden likes to run in:

python3 -m venv env
. env/bin/activate

A short check of the location of your python version should show the ./env/bin/python binary.

which python

To switch back to your usual python executable, simply deactivate the venv:

deactivate

There are more sophisticated tools to keep track of your virtualenvs and python installations. For example, check out pyenv in combination with pyenv-virtualenv.

µRaiden installation for development

When you want to develop on the µRaiden codebase, it is best to install it in pip’s editable mode. This way, you can edit the source code directly and never worry about reinstalling µRaiden - the linked application always reflects the changes you made. To install µRaiden for development, download the repository and run our install script with:

git clone git@github.com:raiden-network/microraiden.git
cd microraiden
make pip-install-dev