X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/79aeb31088914470371195bc998a4e0dd97d6f00..d485aef7019206bc02167d391c91cb1aa47fe6dc:/docs/develop/Development-Environment.md diff --git a/docs/develop/Development-Environment.md b/docs/develop/Development-Environment.md index eba87c09..0e1bbf61 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,13 +32,23 @@ 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) +For testing the Python search frontend, you need to install extra dependencies +depending on your choice of webserver framework: + +* [sanic-testing](https://sanic.dev/en/plugins/sanic-testing/getting-started.html) (sanic only) +* [httpx](https://www.python-httpx.org/) (starlette only) +* [asgi-lifespan](https://github.com/florimondmanca/asgi-lifespan) (starlette only) + 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 @@ -50,9 +60,11 @@ 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 types-psutil \ + sanic-testing httpx asgi-lifespan ``` The `mkdocs` executable will be located in `.local/bin`. You may have to add