packaging/nominatim-api/README.md

   1 # Nominatim - Frontend Library
   2
   3 Nominatim is a tool to search OpenStreetMap data
   4 by name and address (geocoding) and to generate synthetic addresses of
   5 OSM points (reverse geocoding).
   6
   7 This module implements the library for searching in a Nominatim database
   8 imported with the 'nominatim-db' package.
   9
  10 ## Installation
  11
  12 To install the Nominatim API from pypi, run:
  13
  14     pip install nominatim-api
  15
  16 ## Running a Nominatim server
  17
  18 You need falcon or starlette to run Nominatim as a service, as well as
  19 an ASGI-capable server like uvicorn. To install them from pypi run:
  20
  21     pip install falcon uvicorn
  22
  23 You need to have a Nominatim database imported with the 'nominatim-db'
  24 package. Go to the project directory, then run uvicorn as:
  25
  26     uvicorn --factory nominatim.server.falcon.server:run_wsgi
  27
  28 ## Documentation
  29
  30 The full documentation for the Nominatim library can be found at:
  31 https://nominatim.org/release-docs/develop/library/Getting-Started/
  32
  33 The v1 API of the server is documented at:
  34 https://nominatim.org/release-docs/develop/api/Overview/
  35
  36 ## License
  37
  38 The source code is available under a GPLv3 license.