Commit 06cee474 authored by Moul's avatar Moul

[doc] #182: Document Poetry installation and usage

parent 0c113365
......@@ -11,6 +11,7 @@ pip3 install silkaj --user
- [Install with Pip](doc/install_pip.md)
- [Install with pipenv](doc/install_pipenv.md)
- [Install the Development environment](doc/install_poetry.md)
- [Install with the build](doc/install_build.md)
- [Install with docker](doc/install_docker.md)
- [Build an executable with Pyinstaller](doc/build_with_pyinstaller.md)
......
## Install Silkaj in a development environement with Poetry
### Install libsodium
```bash
sudo apt install libsodium23 # Debian Buster
sudo apt install libsodium18 # Debian Stretch
sudo dnf install libsodium # Fedora
```
### Install Poetry
- [Installation documentation](https://poetry.eustace.io/docs/#installation)
### Install dependencies and the Python environment
```bash
poetry install
```
### Run Silkaj
Within `silkaj` repository, enter the development environement and run Silkaj:
```bash
poetry shell
./bin/silkaj
```
You might need to enter Poetry shell to access development tools such as `pytest` or `black`.
### Make Silkaj accessible from everywhere
Add following alias to your shell configuration:
```bash
alias silkaj "$HOME/silkaj/silkaj && poetry run silkaj"
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment