From 4375900a6ef932606f7e0a8d86a592a8a08f4318 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABtan=20Lehmann?= Date: Mon, 22 Sep 2025 10:32:04 +0200 Subject: [PATCH 1/2] Fix pip install commands in the readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The commands where not updated when we chose to use the script to synchronise the requirements.txt files Signed-off-by: Gaëtan Lehmann --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 63eab7be2..2c15ce376 100644 --- a/README.md +++ b/README.md @@ -102,13 +102,13 @@ installation of the dependencies. The base dependencies can be installed with ~~~sh -./pip_install_pyproject.py +pip install -r requirements/base.txt ~~~ Optionally, you can install the development dependencies with ~~~sh -./pip_install_pyproject.py dev +pip install -r requirements/dev.txt ~~~ ### Adding python dependencies From b9fda401b068f3dbdc6098abb5b65d77e004aa4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABtan=20Lehmann?= Date: Mon, 22 Sep 2025 11:22:00 +0200 Subject: [PATCH 2/2] Add code checker commands in the readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Gaëtan Lehmann --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 2c15ce376..335fbf13d 100644 --- a/README.md +++ b/README.md @@ -352,6 +352,22 @@ It is automatically executed after every pull request or commit pushed to this r #### More Check `./jobs.py --help` and `./jobs.py {command name} --help`. +## Development + +This projects uses multiple code checkers to ensure a high quality and coherence of the code. +The checkers are run in the CI on github and will report any failure in the PRs. + +To run the checkers locally, you need to install the dev dependencies, and run these commands: + +```sh +mypy --install-types --non-interactive lib/ conftest.py pkgfixtures.py tests/ +pyright lib/ conftest.py pkgfixtures.py +ruff check lib/ tests/ +flake8 +``` + +The code checker diagnostics can also be shown directly in your IDE or text editor. + ## VM setup Many tests expect VMs with: * OpenSSH server installed and accepting pubkey authentication for the `root` user