Skip to content

Commit 20badcf

Browse files
authored
Merge pull request #352 from xcp-ng/gln/readme-checker-pip-fix-tyys
2 parents a71b5e5 + b9fda40 commit 20badcf

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,13 +102,13 @@ installation of the dependencies.
102102
The base dependencies can be installed with
103103

104104
~~~sh
105-
./pip_install_pyproject.py
105+
pip install -r requirements/base.txt
106106
~~~
107107

108108
Optionally, you can install the development dependencies with
109109

110110
~~~sh
111-
./pip_install_pyproject.py dev
111+
pip install -r requirements/dev.txt
112112
~~~
113113

114114
### Adding python dependencies
@@ -352,6 +352,22 @@ It is automatically executed after every pull request or commit pushed to this r
352352
#### More
353353
Check `./jobs.py --help` and `./jobs.py {command name} --help`.
354354

355+
## Development
356+
357+
This projects uses multiple code checkers to ensure a high quality and coherence of the code.
358+
The checkers are run in the CI on github and will report any failure in the PRs.
359+
360+
To run the checkers locally, you need to install the dev dependencies, and run these commands:
361+
362+
```sh
363+
mypy --install-types --non-interactive lib/ conftest.py pkgfixtures.py tests/
364+
pyright lib/ conftest.py pkgfixtures.py
365+
ruff check lib/ tests/
366+
flake8
367+
```
368+
369+
The code checker diagnostics can also be shown directly in your IDE or text editor.
370+
355371
## VM setup
356372
Many tests expect VMs with:
357373
* OpenSSH server installed and accepting pubkey authentication for the `root` user

0 commit comments

Comments
 (0)