Skip to content

Add code checker commands in the readme #352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add code checker commands in the readme #352

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4375900
Fix pip install commands in the readme
glehmann Sep 22, 2025
b9fda40
Add code checker commands in the readme
glehmann Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down