X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/a87cb77ce83cecddd985a4516927b652aa2b20de..19360a95522828c733e4ab174da9a9147ae308bf:/docs/develop/Development-Environment.md diff --git a/docs/develop/Development-Environment.md b/docs/develop/Development-Environment.md index 9abfae37..64306454 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,21 @@ 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) +* [pytest-asyncio](https://pytest-asyncio.readthedocs.io) + +For testing the Python search frontend, you need to install extra dependencies +depending on your choice of webserver framework: + +* [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.18 +* [mkdocstrings-python](https://mkdocstrings.github.io/python/) ### Installing prerequisites on Ubuntu/Debian @@ -53,8 +62,10 @@ 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 +pip3 install --user behave mkdocs mkdocstrings pytest pytest-asyncio pylint \ + mypy types-PyYAML types-jinja2 types-psycopg2 types-psutil \ + types-ujson types-requests types-Pygments typing-extensions\ + httpx asgi-lifespan ``` The `mkdocs` executable will be located in `.local/bin`. You may have to add