hans/Nominatim
1
0
Fork 1
mirror of https://github.com/osm-search/Nominatim.git synced 2026-03-12 05:44:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

adapt packaging readmes

Browse Source
This commit is contained in:
Sarah Hoffmann
2024-06-15 09:13:31 +02:00
parent 9abf2c248e
commit a93ec09932
3 changed files with 67 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
packaging/nominatim-api/README.md
View File

@@ -1,21 +1,38 @@
Nominatim - frontend library
=========
# 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 in a Nominatim database
imported with the `nominatim-db` package.
imported with the 'nominatim-db' package.
Documentation
=============
## Installation
The documentation of the latest development version is in the
`docs/` subdirectory. A HTML version can be found at
https://nominatim.org/release-docs/develop/ .
To install the Nominatim API from pypi, run:
License
=======
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/develop/library/Getting-Started/
The v1 API of the server is documented at:
https://nominatim.org/release-docs/develop/api/Overview/
## License
The source code is available under a GPLv3 license.