osm-search/Nominatim
1
1
Fork 0
mirror of https://github.com/osm-search/Nominatim.git synced 2024-11-22 12:06:27 +03:00
Code Issues Packages Projects Releases Wiki Activity
bf683d434b
Nominatim/packaging/nominatim-api
History
Sarah Hoffmann 7717bbf59d remove remaining references to php code
2024-09-15 15:33:59 +02:00
..
extra_src remove remaining references to php code 2024-09-15 15:33:59 +02:00
COPYING switch to symlink approach for packages 2024-06-26 11:52:47 +02:00
pyproject.toml add mtm as maintainer for the Python packages 2024-07-01 14:25:26 +02:00
README.md improve wording 2024-06-29 16:27:26 +02:00
settings reduce from 3 to 2 packages 2024-06-28 09:13:22 +02:00
src switch to symlink approach for packages 2024-06-26 11:52:47 +02:00

README.md

Nominatim - Frontend Library

Nominatim is a tool to search OpenStreetMap data by name and address (geocoding) and to generate synthetic addresses of OSM points (reverse geocoding).

This module implements the library for searching a Nominatim database imported with the nominatim-db package.

Installation

To install the Nominatim API from pypi, run:

pip install nominatim-api

Running a Nominatim server

You need Falcon or Starlette to run Nominatim as a service, as well as an ASGI-capable server like uvicorn. To install them from pypi run:

pip install falcon uvicorn

You need to have a Nominatim database imported with the 'nominatim-db' package. Go to the project directory, then run uvicorn as:

uvicorn --factory nominatim.server.falcon.server:run_wsgi

Documentation

The full documentation for the Nominatim library can be found at: https://nominatim.org/release-docs/latest/library/Getting-Started/

The v1 API of the server is documented at: https://nominatim.org/release-docs/latest/api/Overview/

License

The source code is available under a GPLv3 license.