install_poetry.md

Install Silkaj in a development environement with Poetry

Install libsodium

sudo apt install libsodium23 # Debian Buster
sudo apt install libsodium18 # Debian Stretch
sudo dnf install libsodium # Fedora

Install Poetry

• Installation documentation

On Debian Buster

sudo apt install python3-pip python3-venv
sudo apt install libffi-dev # Required on ARMbian
pip3 install poetry --user

Install dependencies and the Python virtual environment

# Over HTTPS
git clone https://git.duniter.org/clients/python/silkaj.git

# Over SSH
git clone git@git.duniter.org:clients/python/silkaj.git

cd silkaj

# Installs the runtime and development dependencies
poetry install

Run Silkaj

Within silkaj repository run Silkaj:

poetry run silkaj

Poetry shell

You can access tools (pytest, black) from within the development environment with poetry run or by entering the shell:

silkaj> poetry run pytest
silkaj> poetry run black

silkaj> poetry shell
(silkaj-58dUTebQ-py3.9) silkaj> black
(silkaj-58dUTebQ-py3.9) silkaj> pytest

Make Silkaj accessible from everywhere

Add following alias to your shell configuration:

alias silkaj="cd /path/to/silkaj && poetry run silkaj"

Contribute

Follow the contributing guide.