erdpy is currently supported on Linux and MacOS. Some of its features might work on Windows as well, although using erdpy on Windows is neither recommended, nor supported at this time.
Before installing erdpy, please make sure you have a working Python 3 (3.6 or later on Linux, 3.8 or later on MacOS) environment.
In order to install erdpy using the
erdpy-up installation script, run the following commands in a terminal:
wget -O erdpy-up.py https://raw.githubusercontent.com/ElrondNetwork/elrond-sdk/master/erdpy-up.pypython3 erdpy-up.py
This will create a light Python virtual environment (based on
~/elrondsdk/erdpy-venv and also include
$PATH variable (by editing the appropriate
If you'd like to install without relying on the easy installation script, please read this section. Otherwise, feel free to skip it.
Make sure you also have pip3 installed.
In order to have the command erdpy available in your shell after install, make sure you adjust the
PATH environment variable as described below:
On Linux in
On MacOS in
~/.zshrc if you’re using
You may need to restart your user session for this changes to take effect.
In order to install erdpy, issue the following command:
pip3 install --user --upgrade --no-cache-dir erdpy
If you encounter encoding-related issues at installation time, such as:
UnicodeDecodeError: 'ascii' codec can't decode byte, then please set
PYTHONIOENCODING before running the install command:
PYTHONIOENCODING=utf8 pip3 install --user --upgrade --no-cache-dir erdpy