docs/develop/Development-Environment.md

   1 # Setting up Nominatim for Development
   2
   3 This chapter gives an overview how to set up Nominatim for development
   4 and how to run tests.
   5
   6 !!! Important
   7     This guide assumes you develop under the latest version of Debian/Ubuntu.
   8     You can of course also use your favourite distribution. You just might have
   9     to adapt the commands below slightly, in particular the commands for
  10     installing additional software.
  11
  12 ## Installing Nominatim
  13
  14 The first step is to install Nominatim itself. Please follow the installation
  15 instructions in the [Admin section](../admin/Installation.md). You don't need
  16 to set up a webserver for development, the webserver that can be started
  17 via `nominatim serve` is sufficient.
  18
  19 If you want to run Nominatim in a VM via Vagrant, use the default `ubuntu24` setup.
  20 Vagrant's libvirt provider runs out-of-the-box under Ubuntu. You also need to
  21 install an NFS daemon to enable directory sharing between host and guest. The
  22 following packages should get you started:
  23
  24     sudo apt install vagrant vagrant-libvirt libvirt-daemon nfs-kernel-server
  25
  26 ## Prerequisites for testing and documentation
  27
  28 The Nominatim test suite consists of behavioural tests (using pytest-bdd) and
  29 unit tests (using pytest). It has the following additional requirements:
  30
  31 * [flake8](https://flake8.pycqa.org/en/stable/) (CI always runs the latest version from pip)
  32 * [mypy](http://mypy-lang.org/) (plus typing information for external libs)
  33 * [Python Typing Extensions](https://github.com/python/typing_extensions) (for Python < 3.9)
  34 * [pytest](https://pytest.org)
  35 * [pytest-asyncio](https://pytest-asyncio.readthedocs.io)
  36 * [pytest-bdd](https://pytest-bdd.readthedocs.io)
  37
  38 For testing the Python search frontend, you need to install extra dependencies
  39 depending on your choice of webserver framework:
  40
  41 * [httpx](https://www.python-httpx.org/) (Starlette only)
  42 * [asgi-lifespan](https://github.com/florimondmanca/asgi-lifespan) (Starlette only)
  43
  44 The documentation is built with mkdocs:
  45
  46 * [mkdocs](https://www.mkdocs.org/) >= 1.1.2
  47 * [mkdocstrings](https://mkdocstrings.github.io/) >= 0.25
  48 * [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)
  49 * [mkdocs-gen-files](https://oprypin.github.io/mkdocs-gen-files/)
  50
  51
  52 ### Installing prerequisites on Ubuntu/Debian
  53
  54 The Python tools should always be run with the most recent version.
  55 The easiest way, to handle these Python dependencies is to run your
  56 development from within a virtual environment.
  57
  58 ```sh
  59 sudo apt install libsqlite3-mod-spatialite osm2pgsql \
  60                  postgresql-postgis postgresql-postgis-scripts \
  61                  pkg-config libicu-dev virtualenv
  62 ```
  63
  64 To set up the virtual environment with all necessary packages run:
  65
  66 ```sh
  67 virtualenv ~/nominatim-dev-venv
  68 ~/nominatim-dev-venv/bin/pip install\
  69     psutil 'psycopg[binary]' PyICU SQLAlchemy \
  70     python-dotenv jinja2 pyYAML \
  71     mkdocs 'mkdocstrings[python]' mkdocs-gen-files \
  72     pytest pytest-asyncio pytest-bdd flake8 \
  73     types-jinja2 types-markupsafe types-psutil types-psycopg2 \
  74     types-pygments types-pyyaml types-requests types-ujson \
  75     types-urllib3 typing-extensions unicorn falcon starlette \
  76     uvicorn mypy osmium aiosqlite
  77 ```
  78
  79 Now enter the virtual environment whenever you want to develop:
  80
  81 ```sh
  82 . ~/nominatim-dev-venv/bin/activate
  83 ```
  84
  85 ### Running Nominatim during development
  86
  87 The source code for Nominatim can be found in the `src` directory and can
  88 be run in-place. The source directory features a special script
  89 `nominatim-cli.py` which does the same as the installed 'nominatim' binary
  90 but executes against the code in the source tree. For example:
  91
  92 ```
  93 me@machine:~$ cd Nominatim
  94 me@machine:~Nominatim$ ./nominatim-cli.py --version
  95 Nominatim version 5.1.0-0
  96 ```
  97
  98 Make sure you have activated the virtual environment holding all
  99 necessary dependencies.
 100
 101 ## Executing Tests
 102
 103 All tests are located in the `/test` directory.
 104
 105 To run all tests, run make from the source root:
 106
 107 ```sh
 108 make tests
 109 ```
 110
 111 There are also make targets for executing only parts of the test suite.
 112 For example to run linting only use:
 113
 114 ```sh
 115 make lint
 116 ```
 117
 118 The possible testing targets are: mypy, lint, pytest, bdd.
 119
 120 For more information about the structure of the tests and how to change and
 121 extend the test suite, see the [Testing chapter](Testing.md).
 122
 123 ## Documentation Pages
 124
 125 The [Nominatim documentation](https://nominatim.org/release-docs/develop/) is
 126 built using the [MkDocs](https://www.mkdocs.org/) static site generation
 127 framework. The master branch is automatically deployed every night on
 128 [https://nominatim.org/release-docs/develop/](https://nominatim.org/release-docs/develop/)
 129
 130 To build the documentation run
 131
 132 ```
 133 make doc
 134 ```
 135
 136
 137 For local testing, you can start webserver:
 138
 139 ```
 140 build> make serve-doc
 141 [server:296] Serving on http://127.0.0.1:8000
 142 [handlers:62] Start watching changes
 143 ```
 144
 145 If you develop inside a Vagrant virtual machine, use a port that is forwarded
 146 to your host:
 147
 148 ```
 149 build> mkdocs serve --dev-addr 0.0.0.0:8088
 150 [server:296] Serving on http://0.0.0.0:8088
 151 [handlers:62] Start watching changes
 152 ```