X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/de724aa57646cad725162bdae56a5a6320cb8ce9..cdfc8628f22a5be2d8ad402adeb9bd6bfcaeface:/docs/develop/Development-Environment.md?ds=sidebyside diff --git a/docs/develop/Development-Environment.md b/docs/develop/Development-Environment.md index 36b34ccb..65dc7990 100644 --- a/docs/develop/Development-Environment.md +++ b/docs/develop/Development-Environment.md @@ -26,16 +26,21 @@ 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 +* [behave test framework](https://behave.readthedocs.io) >= 1.2.6 +* [phpunit](https://phpunit.de) (9.5 is known to work) * [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) -* [Pylint](https://pylint.org/) +* [Pylint](https://pylint.org/) (CI always runs the latest version from pip) +* [mypy](http://mypy-lang.org/) (plus typing information for external libs) +* [Python Typing Extensions](https://github.com/python/typing_extensions) (for Python < 3.9) +* [pytest](https://pytest.org) The documentation is built with mkdocs: * [mkdocs](https://www.mkdocs.org/) >= 1.1.2 +* [mkdocstrings](https://mkdocstrings.github.io/) ### Installing prerequisites on Ubuntu/Debian @@ -47,9 +52,10 @@ 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 -pip3 install --user behave mkdocs +pip3 install --user behave mkdocs mkdocstrings pytest \ + pylint mypy types-PyYAML types-jinja2 types-psycopg2 ``` The `mkdocs` executable will be located in `.local/bin`. You may have to add @@ -111,7 +117,7 @@ symlinks (see `CMakeLists.txt` for the exact steps). Now you can start webserver for local testing ``` -build> mkdocs serve +build> make serve-doc [server:296] Serving on http://127.0.0.1:8000 [handlers:62] Start watching changes ``` @@ -120,7 +126,7 @@ If you develop inside a Vagrant virtual machine, use a port that is forwarded to your host: ``` -build> mkdocs serve --dev-addr 0.0.0.0:8088 +build> PYTHONPATH=$SRCDIR mkdocs serve --dev-addr 0.0.0.0:8088 [server:296] Serving on http://0.0.0.0:8088 [handlers:62] Start watching changes ```