X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/de724aa57646cad725162bdae56a5a6320cb8ce9..36447c488a78017dc533f7ed42bc8cf20c72556d:/docs/develop/Development-Environment.md diff --git a/docs/develop/Development-Environment.md b/docs/develop/Development-Environment.md index 36b34ccb..43598b9a 100644 --- a/docs/develop/Development-Environment.md +++ b/docs/develop/Development-Environment.md @@ -26,12 +26,14 @@ following packages should get you started: ## Prerequisites for testing and documentation The Nominatim test suite consists of behavioural tests (using behave) and -unit tests (using PHPUnit). It has the following additional requirements: +unit tests (using PHPUnit for PHP code and pytest for Python code). +It has the following additional requirements: * [behave test framework](https://behave.readthedocs.io) >= 1.2.5 * [phpunit](https://phpunit.de) >= 7.3 * [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) -* [Pylint](https://pylint.org/) +* [Pylint](https://pylint.org/) (2.6.0 is used for the CI) +* [pytest](https://pytest.org) The documentation is built with mkdocs: @@ -47,9 +49,9 @@ To install all necessary packages run: ```sh sudo apt install php-cgi phpunit php-codesniffer \ - python3-pip python3-setuptools python3-dev pylint3 + python3-pip python3-setuptools python3-dev pylint -pip3 install --user behave mkdocs +pip3 install --user behave mkdocs pytest ``` The `mkdocs` executable will be located in `.local/bin`. You may have to add