| Name | nominatim-api JSON |
| Version |
4.5.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 | 2024-09-12 11:54:35 |
| 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/f8/d7/72154063ce68cc3c026835488dadc174e32ffbf6237b00066de9f6319a16/nominatim_api-4.5.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": "4.5.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": "aca60590672a6c526b389cd360704c34ef49adddf4abc08cd30a77a6a6d0ae74",
"md5": "924a7d383a735062b3949af3dde04daa",
"sha256": "c63761e0069962f06d44f855cff4ae10f2c41c2d2b615d9a486f6299ef78c9e5"
},
"downloads": -1,
"filename": "nominatim_api-4.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "924a7d383a735062b3949af3dde04daa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 501465,
"upload_time": "2024-09-12T11:54:19",
"upload_time_iso_8601": "2024-09-12T11:54:19.516989Z",
"url": "https://files.pythonhosted.org/packages/ac/a6/0590672a6c526b389cd360704c34ef49adddf4abc08cd30a77a6a6d0ae74/nominatim_api-4.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f8d772154063ce68cc3c026835488dadc174e32ffbf6237b00066de9f6319a16",
"md5": "42271c46eb7e0ebd7fd4abe8d364bafc",
"sha256": "6783ede298d0089a3e2de01ec4d25fb8f0534846346cf1535beb0f36c7c56f44"
},
"downloads": -1,
"filename": "nominatim_api-4.5.0.tar.gz",
"has_sig": false,
"md5_digest": "42271c46eb7e0ebd7fd4abe8d364bafc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 345025,
"upload_time": "2024-09-12T11:54:35",
"upload_time_iso_8601": "2024-09-12T11:54:35.858251Z",
"url": "https://files.pythonhosted.org/packages/f8/d7/72154063ce68cc3c026835488dadc174e32ffbf6237b00066de9f6319a16/nominatim_api-4.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-12 11:54:35",
"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"
}
