X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/fedc8ed4740686e396fb21c495d887d8ee23609a..f5e52e748f0a4275e3238e51c47de2ddccfea0ff:/docs/develop/Development-Environment.md diff --git a/docs/develop/Development-Environment.md b/docs/develop/Development-Environment.md index eba87c09..6bb33f00 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 @@ -32,7 +32,9 @@ It has the following additional requirements: * [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/) (2.6.0 is used for the CI) +* [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: @@ -50,9 +52,10 @@ To install all necessary packages run: ```sh sudo apt install php-cgi phpunit php-codesniffer \ - python3-pip python3-setuptools python3-dev pylint + python3-pip python3-setuptools python3-dev -pip3 install --user behave mkdocs mkdocstrings pytest +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