X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/9d716f0f7d0901dea1a0dfbadb0356c83b11adc0..4efad0bb95024e2082f73b4ae33613ef8f6ebef3:/docs/develop/Development-Environment.md diff --git a/docs/develop/Development-Environment.md b/docs/develop/Development-Environment.md index 05bd50de..c6515d2c 100644 --- a/docs/develop/Development-Environment.md +++ b/docs/develop/Development-Environment.md @@ -1,6 +1,6 @@ # Setting up Nominatim for Development -This chapter gives an overview how to set up Nominatim for developement +This chapter gives an overview how to set up Nominatim for development and how to run tests. !!! Important @@ -34,12 +34,14 @@ It has the following additional requirements: * [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) * [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/) +* [mkdocstrings](https://mkdocstrings.github.io/) >= 0.16 +* [mkdocstrings-python-legacy](https://mkdocstrings.github.io/python-legacy/) ### Installing prerequisites on Ubuntu/Debian @@ -53,8 +55,8 @@ To install all necessary packages run: sudo apt install php-cgi phpunit php-codesniffer \ python3-pip python3-setuptools python3-dev -pip3 install --user behave mkdocs mkdocstrings pytest \ - pylint mypy types-PyYAML types-jinja2 types-psycopg2 +pip3 install --user behave mkdocs mkdocstrings pytest pylint \ + mypy types-PyYAML types-jinja2 types-psycopg2 types-psutil ``` The `mkdocs` executable will be located in `.local/bin`. You may have to add