X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/7282d816c8d70fa70e199ec8e4b5b679fbaa1caa..20d0fb35ce9d4d7c006a0e77dcf25edc2e8509b3:/docs/develop/Development-Environment.md diff --git a/docs/develop/Development-Environment.md b/docs/develop/Development-Environment.md index 1db32a6e..a6558c7d 100644 --- a/docs/develop/Development-Environment.md +++ b/docs/develop/Development-Environment.md @@ -26,13 +26,10 @@ 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) +* [flake8](https://flake8.pycqa.org/en/stable/) (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) @@ -58,10 +55,13 @@ the vendored version of osm2pgsql, you need to set the PATH accordingly. ### Installing prerequisites on Ubuntu/Debian The Python tools should always be run with the most recent version. -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 @@ -69,10 +69,11 @@ virtualenv ~/nominatim-dev-venv ~/nominatim-dev-venv/bin/pip install\ psutil psycopg[binary] PyICU SQLAlchemy \ python-dotenv jinja2 pyYAML datrie behave \ - mkdocs mkdocstrings mkdocs-gen-files pytest pytest-asyncio pylint \ + mkdocs mkdocstrings mkdocs-gen-files pytest pytest-asyncio flake8 \ 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 +82,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