]> git.openstreetmap.org Git - nominatim.git/blobdiff - docs/develop/Development-Environment.md
add type annotations to config module
[nominatim.git] / docs / develop / Development-Environment.md
index eba87c09e68138e20b08fdacb3f9139a8efd1345..9abfae3765d049a040b2e61e8fe08ed5538f59fa 100644 (file)
@@ -32,7 +32,8 @@ 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)
 * [pytest](https://pytest.org)
 
 The documentation is built with mkdocs:
@@ -50,9 +51,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
 ```
 
 The `mkdocs` executable will be located in `.local/bin`. You may have to add