X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/7282d816c8d70fa70e199ec8e4b5b679fbaa1caa..ad50016c498098d0f0850c3a9de60623a3bd7e1f:/docs/develop/Development-Environment.md?ds=sidebyside diff --git a/docs/develop/Development-Environment.md b/docs/develop/Development-Environment.md index 1db32a6e..441556ff 100644 --- a/docs/develop/Development-Environment.md +++ b/docs/develop/Development-Environment.md @@ -26,12 +26,9 @@ following packages should get you started: ## Prerequisites for testing and documentation The Nominatim test suite consists of behavioural tests (using behave) and -unit tests (using PHPUnit for PHP code and pytest for Python code). -It has the following additional requirements: +unit tests (using pytest). 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/) (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) @@ -62,6 +59,10 @@ In particular, pylint tends to have a lot of breaking changes between versions. The easiest way, to handle these Python dependencies is to run your development from within a virtual environment. +```sh +sudo apt install libsqlite3-mod-spatialite +``` + To set up the virtual environment with all necessary packages run: ```sh @@ -72,7 +73,8 @@ virtualenv ~/nominatim-dev-venv mkdocs mkdocstrings mkdocs-gen-files pytest pytest-asyncio pylint \ types-jinja2 types-markupsafe types-psutil types-psycopg2 \ types-pygments types-pyyaml types-requests types-ujson \ - types-urllib3 typing-extensions unicorn falcon + types-urllib3 typing-extensions unicorn falcon starlette \ + uvicorn mypy osmium aiosqlite ``` Now enter the virtual environment whenever you want to develop: @@ -81,28 +83,6 @@ Now enter the virtual environment whenever you want to develop: . ~/nominatim-dev-venv/bin/activate ``` -For installing the PHP development tools, run: - -```sh -sudo apt install php-cgi phpunit php-codesniffer -``` - -If your distribution does not have PHPUnit 7.3+, you can install it (as well -as CodeSniffer) via composer: - -``` -sudo apt-get install composer -composer global require "squizlabs/php_codesniffer=*" -composer global require "phpunit/phpunit=8.*" -``` - -The binaries are found in `.config/composer/vendor/bin`. You need to add this -to your PATH: - -``` -echo 'export PATH=~/.config/composer/vendor/bin:$PATH' > ~/.profile -``` - ### Running Nominatim during development The source code for Nominatim can be found in the `src` directory and can