From 82fc69655ec898398bd5a1eeb960ff80d9662470 Mon Sep 17 00:00:00 2001 From: Alex Pyrgiotis Date: Tue, 1 Nov 2022 18:23:21 +0200 Subject: [PATCH] Align Poetry instructions across OSes Align build instructions about Python Poetry, which where previously present only on MacOS and Windows. With this commit we: 1. Add Poetry instructions on Linux. 2. Add missing Poetry instructions on Windows, when running Dangerzone from source. --- BUILD.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/BUILD.md b/BUILD.md index 197589f..7bffa9a 100644 --- a/BUILD.md +++ b/BUILD.md @@ -8,6 +8,18 @@ Install dependencies: sudo apt install -y podman dh-python python3 python3-stdeb python3-pyside2.qtcore python3-pyside2.qtgui python3-pyside2.qtwidgets python3-appdirs python3-click python3-xdg python3-colorama ``` +Install poetry: + +```sh +python -m pip install poetry +``` + +Change to the `dangerzone` folder, and install the poetry dependencies: + +``` +poetry install +``` + Build the latest container: ```sh @@ -17,6 +29,13 @@ Build the latest container: Run from source tree: ```sh +# start a shell in the virtual environment +poetry shell + +# run the CLI +./dev_scripts/dangerzone-cli --help + +# run the GUI ./dev_scripts/dangerzone ``` @@ -34,6 +53,18 @@ Install dependencies: sudo dnf install -y rpm-build podman python3 python3-setuptools python3-pyside2 python3-appdirs python3-click python3-pyxdg python3-colorama ``` +Install poetry: + +```sh +python -m pip install poetry +``` + +Change to the `dangerzone` folder, and install the poetry dependencies: + +``` +poetry install +``` + Build the latest container: ```sh @@ -43,6 +74,13 @@ Build the latest container: Run from source tree: ```sh +# start a shell in the virtual environment +poetry shell + +# run the CLI +./dev_scripts/dangerzone-cli --help + +# run the GUI ./dev_scripts/dangerzone ``` @@ -134,8 +172,14 @@ python .\install\windows\build-image.py After that you can launch dangerzone during development with: ``` -.\dev_scripts\dangerzone.bat +# start a shell in the virtual environment +poetry shell + +# run the CLI .\dev_scripts\dangerzone-cli.bat --help + +# run the GUI +.\dev_scripts\dangerzone.bat ``` ### If you want to build the installer