| Name | nominatim-api JSON |
| Version |
5.0.0
JSON |
| download |
| home_page | None |
| Summary | A tool for building a database of OpenStreetMap for geocoding and for searching the database. Search library. |
| upload_time | 2025-02-07 10:26:43 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
openstreetmap
geocoding
search
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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`](https://pypi.org/project/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.
Raw data
{
"_id": null,
"home_page": null,
"name": "nominatim-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Sarah Hoffmann <lonvia@denofr.de>, Marc Tobias <mtmail-cpan@gmx.net>",
"keywords": "OpenStreetMap, geocoding, search",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/dd/bf/0b2c4fbc17695237ac853fddb1cd99bcd34c62efb650141e946c212c977f/nominatim_api-5.0.0.tar.gz",
"platform": null,
"description": "# Nominatim - Frontend Library\n\nNominatim is a tool to search OpenStreetMap data\nby name and address (geocoding) and to generate synthetic addresses of\nOSM points (reverse geocoding).\n\nThis module implements the library for searching a Nominatim database\nimported with the [`nominatim-db`](https://pypi.org/project/nominatim-db/) package.\n\n## Installation\n\nTo install the Nominatim API from pypi, run:\n\n pip install nominatim-api\n\n## Running a Nominatim server\n\nYou need Falcon or Starlette to run Nominatim as a service, as well as\nan ASGI-capable server like uvicorn. To install them from pypi run:\n\n pip install falcon uvicorn\n\nYou need to have a Nominatim database imported with the 'nominatim-db'\npackage. Go to the project directory, then run uvicorn as:\n\n uvicorn --factory nominatim.server.falcon.server:run_wsgi\n\n## Documentation\n\nThe full documentation for the Nominatim library can be found at:\nhttps://nominatim.org/release-docs/latest/library/Getting-Started/\n\nThe v1 API of the server is documented at:\nhttps://nominatim.org/release-docs/latest/api/Overview/\n\n## License\n\nThe source code is available under a GPLv3 license.\n",
"bugtrack_url": null,
"license": null,
"summary": "A tool for building a database of OpenStreetMap for geocoding and for searching the database. Search library.",
"version": "5.0.0",
"project_urls": {
"Documentation": "https://nominatim.org/release-docs/latest/",
"Homepage": "https://nominatim.org",
"Issues": "https://github.com/osm-search/Nominatim/issues",
"Repository": "https://github.com/osm-search/Nominatim"
},
"split_keywords": [
"openstreetmap",
" geocoding",
" search"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c06cb1fc66aa4052dcb58fd9d085caa8968a6273fc7aa26723f9c5344aea18f0",
"md5": "226088a841d8d064dc8596376aae76f7",
"sha256": "240031bf625b9a660f30da2b1a976e3c31054378b06d94a5e2d71ea5eb26f7db"
},
"downloads": -1,
"filename": "nominatim_api-5.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "226088a841d8d064dc8596376aae76f7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 491383,
"upload_time": "2025-02-07T10:26:26",
"upload_time_iso_8601": "2025-02-07T10:26:26.409058Z",
"url": "https://files.pythonhosted.org/packages/c0/6c/b1fc66aa4052dcb58fd9d085caa8968a6273fc7aa26723f9c5344aea18f0/nominatim_api-5.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ddbf0b2c4fbc17695237ac853fddb1cd99bcd34c62efb650141e946c212c977f",
"md5": "5fb5112ff212c3f553480f699d321dcb",
"sha256": "1af2fe173cc0c5c515ced5f380154b666fcaad8bf6fc7175c7e7a6ab30974311"
},
"downloads": -1,
"filename": "nominatim_api-5.0.0.tar.gz",
"has_sig": false,
"md5_digest": "5fb5112ff212c3f553480f699d321dcb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 341061,
"upload_time": "2025-02-07T10:26:43",
"upload_time_iso_8601": "2025-02-07T10:26:43.215008Z",
"url": "https://files.pythonhosted.org/packages/dd/bf/0b2c4fbc17695237ac853fddb1cd99bcd34c62efb650141e946c212c977f/nominatim_api-5.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-07 10:26:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "osm-search",
"github_project": "Nominatim",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nominatim-api"
}
