nominatim-api 4.4.99.dev1__tar.gz

nominatim_api-4.4.99.dev1/.gitignore

@@ -0,0 +1,12 @@
+*.log
+*.pyc
+*.swp
+
+docs/develop/*.png
+
+build
+dist
+.coverage
+
+.vagrant
+data/country_osm_grid.sql.gz

nominatim_api-4.4.99.dev1/COPYING

@@ -0,0 +1 @@
+../../COPYING

nominatim_api-4.4.99.dev1/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.3
+Name: nominatim-api
+Version: 4.4.99.dev1
+Summary: A tool for building a database of OpenStreetMap for geocoding and for searching the database. Search library.
+Project-URL: Homepage, https://nominatim.org
+Project-URL: Issues, https://github.com/osm-search/Nominatim/issues
+Maintainer-email: Sarah Hoffmann <lonvia@denofr.de>
+License-Expression: GPL-3.0-or-later
+License-File: COPYING
+Keywords: OpenStreetMap,geocoding,search
+Classifier: License :: OSI Approved :: GNU General Public License (GPL)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.7
+Requires-Dist: psycopg
+Requires-Dist: pyicu
+Requires-Dist: python-dotenv
+Requires-Dist: pyyaml>=5.1
+Requires-Dist: sqlalchemy>=1.4.31
+Description-Content-Type: text/markdown
+
+# 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.
+
+## 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/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.

nominatim_api-4.4.99.dev1/README.md

@@ -0,0 +1,38 @@
+# 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.
+
+## 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/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.

nominatim_api-4.4.99.dev1/extra_src/paths.py

@@ -0,0 +1,15 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Nominatim. (https://nominatim.org)
+#
+# Copyright (C) 2024 by the Nominatim developer community.
+# For a full list of authors see the git log.
+"""
+Path settings for extra data used by Nominatim.
+"""
+from pathlib import Path
+
+PHPLIB_DIR = None
+DATA_DIR = None
+SQLLIB_DIR = None
+CONFIG_DIR = (Path(__file__) / '..' / 'resources' / 'settings').resolve()

nominatim_api-4.4.99.dev1/pyproject.toml

@@ -0,0 +1,55 @@
+[project]
+name = "nominatim-api"
+description = "A tool for building a database of OpenStreetMap for geocoding and for searching the database. Search library."
+readme = "README.md"
+requires-python = ">=3.7"
+license = 'GPL-3.0-or-later'
+maintainers = [
+  { name = "Sarah Hoffmann", email = "lonvia@denofr.de" }
+]
+keywords = [ "geocoding", "OpenStreetMap", "search" ]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: GNU General Public License (GPL)",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "python-dotenv",
+    "pyYAML>=5.1",
+    "SQLAlchemy>=1.4.31",
+    "psycopg",
+    "PyICU"
+]
+version = "4.4.99.dev1"
+
+[project.urls]
+Homepage = "https://nominatim.org"
+Issues = "https://github.com/osm-search/Nominatim/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/nominatim_api/version.py"
+pattern = "NOMINATIM_API_VERSION = '(?P<version>[^']+)'"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/nominatim_api",
+    "src/nominatim_db/config.py",
+    "settings",
+    "extra_src/paths.py"
+]
+
+exclude = [
+  "src/nominatim_api/config.py"
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/nominatim_api"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"src/nominatim_db/config.py" = "nominatim_api/config.py"
+"extra_src/paths.py" = "nominatim_api/paths.py"
+"settings" = "nominatim_api/resources/settings"

nominatim_api-4.4.99.dev1/settings/address-levels.json

@@ -0,0 +1,226 @@
+[
+{ "tags" : {
+      "place" : {
+          "sea" : [2, 0],
+          "island" : [17, 0],
+          "islet" : [20, 0],
+          "continent" : [2, 0],
+          "country" : [4, 0],
+          "state" : [8, 0],
+          "province" : [8, 0],
+          "region" : [18, 0],
+          "county" : 12,
+          "district" : 12,
+          "municipality" : 14,
+          "city" : 16,
+          "town" : [18, 16],
+          "borough" : 18,
+          "village" : [19, 16],
+          "suburb" : [19, 20],
+          "hamlet" : 20,
+          "croft" : 20,
+          "subdivision" : 22,
+          "allotments" : 22,
+          "neighbourhood" : [20, 22],
+          "quarter" : [20, 22],
+          "isolated_dwelling" : [22, 20],
+          "farm" : [22, 20],
+          "city_block" : 25,
+          "mountain_pass" : 25,
+          "square" : 25,
+          "locality" : 25,
+          "houses" : [28, 0],
+          "house" : 30,
+          "" : [22, 0]
+      },
+      "boundary" : {
+          "administrative2" : 4,
+          "administrative3" : 6,
+          "administrative4" : 8,
+          "administrative5" : 10,
+          "administrative6" : 12,
+          "administrative7" : 14,
+          "administrative8" : 16,
+          "administrative9" : 18,
+          "administrative10" : 20,
+          "administrative11" : 22,
+          "administrative12" : 24,
+          "" : [25, 0]
+      },
+      "landuse" : {
+          "residential" : 22,
+          "farm" : 22,
+          "farmyard" : 22,
+          "industrial" : 22,
+          "commercial" : 22,
+          "allotments" : 22,
+          "retail" : 22,
+          "" : [22, 0]
+      },
+      "leisure" : {
+          "park" : [24, 0]
+      },
+      "natural" : {
+          "peak" : [18, 0],
+          "volcano" : [18, 0],
+          "mountain_range" : [18, 0],
+          "sea" : [4, 0],
+          "tree" : 30,
+          "spring"  : 30,
+          "cave_entrance" : 30,
+          "geyser" : 30,
+          "hot_spring" : 30,
+          "rock" : 30,
+          "stone" : 30,
+          "" : [22, 0]
+      },
+      "waterway" : {
+          "river" : [19, 0],
+          "stream" : [22, 0],
+          "ditch" : [22, 0],
+          "drain" : [22, 0],
+          "" : [20, 0]
+      },
+      "highway" : {
+          "" : 30,
+          "service" : 27,
+          "cycleway" : 27,
+          "path" : 27,
+          "footway" : 27,
+          "steps" : 27,
+          "bridleway" : 27,
+          "motorway_link" : 27,
+          "primary_link" : 27,
+          "trunk_link" : 27,
+          "secondary_link" : 27,
+          "tertiary_link" : 27,
+          "residential" : 26,
+          "track" : 26,
+          "unclassified" : 26,
+          "tertiary" : 26,
+          "secondary" : 26,
+          "primary" : 26,
+          "living_street" : 26,
+          "trunk" : 26,
+          "motorway" : 26,
+          "pedestrian" : 26,
+          "road" : 26,
+          "construction" : 26
+      },
+      "mountain_pass" : {
+          "" : [20, 0]
+      },
+      "historic" : {
+          "neighbourhood" : [22, 0]
+      }
+  }
+},
+{ "countries" : [ "ca" ],
+  "tags" : {
+      "place" : {
+          "county" : [12, 0]
+      }
+  }
+},
+{ "countries" : [ "de" ],
+  "tags" : {
+      "place" : {
+          "region" : [10, 0],
+          "county" : [12, 0]
+      },
+      "boundary" : {
+          "administrative5" : [10, 0]
+      }
+  }
+},
+{ "countries" : [ "be" ],
+  "tags" : {
+      "boundary" : {
+          "administrative3" : [5, 0],
+          "administrative4" : 6,
+          "administrative5" : [7, 0],
+          "administrative6" : 8,
+          "administrative7" : 12,
+          "administrative8" : 14,
+          "administrative9" : 16,
+          "administrative10" : 18
+      }
+  }
+},
+{ "countries" : ["se", "no"],
+  "tags" : {
+      "place" : {
+      },
+      "boundary" : {
+          "administrative3" : 8,
+          "administrative4" : 12
+      }
+  }
+},
+{ "countries" : ["id"],
+  "tags" : {
+      "place" : {
+          "municipality" : 18
+      },
+      "boundary" : {
+          "administrative5" : 12,
+          "administrative6" : 14,
+          "administrative7" : 16,
+          "administrative8" : 20,
+          "administrative9" : 22,
+          "administrative10" : 24
+      }
+  }
+},
+{ "countries" : ["ru"],
+  "tags" : {
+      "place" : {
+          "municipality" : 18
+      },
+      "boundary" : {
+          "administrative5" : [10, 0],
+          "administrative7" : [13, 0],
+          "administrative8" : 14
+      }
+  }
+},
+{ "countries" : [ "nl" ],
+  "tags" : {
+      "boundary" : {
+          "administrative7" : [13, 0],
+          "administrative8" : 14,
+          "administrative9" : [15, 0],
+          "administrative10" : 16
+      }
+  }
+},
+{ "countries" : ["es"],
+  "tags" : {
+      "place" : {
+          "province" : 10,
+          "civil_parish" : 18
+      },
+      "boundary" : {
+          "administrative5" : [10, 0],
+          "administrative6" : 10,
+          "administrative7" : 12,
+          "administrative10" : 22
+      }
+  }
+},
+{ "countries" : ["sk"],
+  "tags" : {
+      "boundary" : {
+          "administrative5" : [10, 0],
+          "administrative6" : 11,
+          "administrative7" : [11, 0],
+          "administrative8" : 12,
+          "administrative9" : 16,
+          "administrative10" : 18,
+          "administrative11" : 20
+      }
+  }
+}
+
+]
+

nominatim_api-4.4.99.dev1/settings/country-names/ad.yaml

@@ -0,0 +1,158 @@
+name: 
+    default: Andorra
+    ab: Андора
+    af: Andorra
+    ak: Andora
+    am: አንዶራ
+    an: Andorra
+    ar: أندورا
+    av: Андо́рра
+    az: Andorra
+    ba: Андо́рра
+    be: Андо́ра
+    bg: Андора
+    bh: अंडोरा
+    bi: Andorra
+    bm: Andɔr
+    bn: অ্যান্ডোরা
+    bo: ཨན་ཌོར་ར།
+    br: Andorra
+    bs: Andora
+    ca: Andorra
+    ce: Андо́рра
+    co: Andorra
+    cs: Andorra
+    cu: Андо́ра
+    cv: Андорра
+    cy: Andorra
+    da: Andorra
+    de: Andorra
+    dv: އެންޑޯރާ
+    dz: ཨཱན་དོ་ར
+    ee: Andorra
+    el: Ανδόρρα
+    en: Andorra
+    eo: Andoro
+    es: Andorra
+    et: Andorra
+    eu: Andorra
+    fa: آندورا
+    ff: Anndoora
+    fi: Andorra
+    fo: Andorra
+    fr: Andorre
+    fy: Andorra
+    ga: Andóra
+    gd: Andorra
+    gl: Andorra
+    gn: Andorra
+    gu: એન્ડોરા
+    gv: Andorra
+    ha: Andorra
+    he: אַנְדּוֹרָה
+    hi: अण्डोरा
+    hr: Andora
+    ht: Andora
+    hu: Andorra
+    hy: Անդորրա
+    ia: Andorra
+    id: Andorra
+    ie: Andorra
+    ig: Andorra
+    io: Andora
+    is: Andorra
+    it: Andorra
+    ja: アンドラ
+    jv: Andorra
+    ka: ანდორა
+    kg: Andora
+    ki: Andora
+    kk: Андорра
+    kl: Andorra
+    km: អង់ដូរ៉ា
+    kn: ಅಂಡೋರ
+    ko: 안도라
+    ks: اٮ۪نڑورا
+    ku: Andorra
+    kv: Андорра
+    kw: Andorra
+    ky: Андорра
+    la: Andorra
+    lb: Andorra
+    lg: Andora
+    li: Andorra
+    ln: Andora
+    lo: ອັງດອກ
+    lt: Andora
+    lv: Andora
+    mg: Andora
+    mi: Andorra
+    mk: Андора
+    ml: അൻഡോറ
+    mn: Андорра
+    mr: आंदोरा
+    ms: Andorra
+    mt: Andorra
+    my: အင်ဒိုရာနိုင်ငံ
+    na: Andorra
+    ne: एण्डोरा
+    nl: Andorra
+    nn: Andorra
+    "no": Andorra
+    nv: Andówa
+    oc: Andòrra
+    om: Andooraa
+    or: ଆଣ୍ଡୋରା
+    os: Андоррæ
+    pa: ਅੰਡੋਰਾ
+    pi: अंडोरा
+    pl: Andora
+    ps: اندورا
+    pt: Andorra
+    qu: Andurra
+    rm: Andorra
+    rn: Andora
+    ro: Andorra
+    ru: Андорра
+    rw: Andora
+    sa: अण्डोरा
+    sc: Andorra
+    sd: انڊورا
+    se: Andorra
+    sg: Andôro
+    sh: Andora
+    si: ඇන්ඩෝරා
+    sk: Andorra
+    sl: Andora
+    sm: Andora
+    sn: Andorra
+    so: Andorra
+    sq: Andorra
+    sr: Андора
+    ss: iYandola
+    su: Andorra
+    sv: Andorra
+    sw: Andorra
+    ta: அண்டோரா
+    te: అండొర్రా
+    tg: Андорра
+    th: อันดอร์รา
+    ti: አንዶራ
+    tk: Andorra
+    tl: Andorra
+    to: ʻEnitola
+    tr: Andorra
+    ts: Andorra
+    tt: Андорра
+    tw: Andorra
+    ug: ئاندوررا
+    uk: Андо́рра
+    ur: انڈورا
+    uz: Andorra
+    vi: Andorra
+    vo: Landorän
+    wo: Andoor
+    yi: אַנדאָרע
+    yo: Àndórà
+    zh: 安道爾
+    zu: I-Andora

nominatim_api-4.4.99.dev1/settings/country-names/ae.yaml

@@ -0,0 +1,122 @@
+name: 
+    default: الإمارات العربية المتحدة
+    af: Verenigde Arabiese Emirate
+    am: የተባበሩት የዓረብ ግዛቶች
+    an: Emiratos Arabes Unitos
+    ar: الإمارات العربية المتحدة
+    av: ГIарабазул Цолъарал Имаратал
+    az: Birləşmiş Ərəb Əmirlikləri
+    be: Аб'яднаныя Арабскія Эміраты
+    bg: Обединени арабски емирства
+    bn: সংযুক্ত আরব আমিরাত
+    bo: ཡི་ནེ་ཁྲེ་ཀྲི་ཨ་རབ་ཨེ་མེ་རེ་ཁྲི།
+    br: Emirelezhioù Arab Unanet
+    bs: Ujedinjeni Arapski Emirati
+    ca: Emirats Àrabs Units
+    ce: Ӏарбийн Цхьаьнакхетта Эмираташ
+    cs: Spojené arabské emiráty
+    cy: Yr Emiradau Arabaidd Unedig
+    da: Forenede Arabiske Emirater
+    de: Vereinigte Arabische Emirate
+    dv: އެކުވެރި ޢަރަބި އިމާރާތު
+    dz: ཡུ་ནའི་ཊེཊ་ཨ་རབ་ཨེ་མི་རེཊསི་
+    el: Ηνωμένα Αραβικά Εμιράτα
+    en: United Arab Emirates
+    eo: Unuiĝintaj Arabaj Emirlandoj
+    es: Emiratos Árabes Unidos
+    et: Araabia Ühendemiraadid
+    eu: Arabiar Emirerri Batuak
+    fa: امارات متحده عربی
+    fi: Yhdistyneet arabiemiirikunnat
+    fo: Sameindu Emirríkini
+    fr: Émirats arabes unis
+    fy: Feriene Arabyske Emiraten
+    ga: Aontas na nÉimíríochtaí Arabacha
+    gd: Na h-Iomaratan Arabach Aonaichte
+    gl: Emiratos Árabes Unidos
+    gn: Aravia Emiryvy Joaju
+    gv: Ny h-Emmiraidyn Arabagh Unnaneysit
+    he: איחוד האמירויות הערביות
+    hi: संयुक्त अरब अमीरात
+    hr: Ujedinjeni Arapski Emirati
+    ht: Emira Arab Ini
+    hu: Egyesült Arab Emírségek
+    hy: Արաբական Միացյալ Էմիրություններ
+    ia: Emiratos Arabe Unite
+    id: Uni Emirat Arab
+    ie: Unit Arabic Emiratus
+    io: Unionita Araba Emirati
+    is: Sameinuðu arabísku furstadæmin
+    it: Emirati Arabi Uniti
+    ja: アラブ首長国連邦
+    jv: Uni Emirat Arab
+    ka: არაბთა გაერთიანებული საამიროები
+    ki: United Arab Emirates
+    kk: Біріккен Араб Әмірліктері
+    kl: United Arab Emirates
+    kn: ಸಂಯುಕ್ತ ಅರಬ ಅಮೀರಾತ
+    ko: 아랍에미리트
+    ku: Mîrnişînên Erebî yên Yekbûyî
+    kv: Ӧтувтчӧм Араб Эмиратъяс
+    kw: Pennternasedh Unys Arabek
+    ky: Бириккен Араб Эмирликтери
+    la: Phylarchiarum Arabicarum Confoederatio
+    lb: Vereenegt Arabesch Emiraten
+    li: Vereinegde Arabische Emiraote
+    lt: Jungtiniai Arabų Emyratai
+    lv: Apvienotie Arābu Emirāti
+    mi: Te Kotahitanga o ngā Whenua Ārapi
+    mk: Обединети Арапски Емирати
+    ml: ഐക്യ അറബ് എമിറേറ്റുകൾ
+    mn: Арабын Нэгдсэн Эмирт Улс
+    mr: संयुक्त अरब अमिराती
+    ms: Emiriah Arab Bersatu
+    mt: Emirati Għarab Magħquda
+    my: အာရပ်စော်ဘွားများပြည်ထောင်စုနိုင်ငံ
+    na: Emireitit Arabiya
+    ne: संयुक्त अरब इमिरेट्स
+    nl: Verenigde Arabische Emiraten
+    nn: Dei sameinte arabiske emirata
+    "no": De forente arabiske emirater
+    nv: Ásáí Bikéyah Yázhí Ałhidadiidzooígíí
+    oc: Emirats Arabis Units
+    or: ୟୁନାଇଟେଡ଼ ଆରବ ଏମିରଟ
+    os: Араббы Иугонд Эмираттæ
+    pa: ਸੰਯੁਕਤ ਅਰਬ ਇਮਰਾਤ
+    pl: Emiraty Arabskie
+    ps: عربي متحده امارات
+    pt: Emirados Árabes Unidos
+    qu: Hukllachasqa Arab Imiratukuna
+    ro: Emiratele Arabe Unite
+    ru: Объединённые Арабские Эмираты
+    rw: Nyarabu Zunze Ubumwe
+    sd: گڏيل عرب امارات
+    se: Ovttastuvvan arábaemiráhtat
+    sh: Ujedinjeni Arapski Emirati
+    sk: Spojené arabské emiráty
+    sl: Združeni arabski emirati
+    so: Imaaraatka Carabta
+    sq: Emiratet e Bashkuara Arabe
+    sr: Уједињени Арапски Емирати
+    ss: Bunye bema-Arabhu
+    su: Uni Émirat Arab
+    sv: Förenade Arabemiraten
+    sw: Falme za Kiarabu
+    ta: ஐக்கிய அரபு அமீரகம்
+    te: యునైటెడ్ అరబ్ ఎమిరేట్స్
+    tg: Аморати Муттаҳидаи Араб
+    th: สหรัฐอาหรับเอมิเรตส์
+    tk: Birleşen Arap Emirlikleri
+    tl: United Arab Emirates
+    tr: Birleşik Arap Emirlikleri
+    tt: Берләшкән Гарәп Әмирлекләре
+    ug: ئەرەب بىرلەشمە خەلىپىلىكى
+    uk: Об'єднані Арабські Емірати
+    ur: متحدہ عرب امارات
+    uz: Birlashgan Arab Amirliklari
+    vi: Các Tiểu vương quốc Ả Rập Thống nhất
+    vo: Lemiräns Larabik Pebalöl
+    wo: Imaaraat yu Araab yu Bennoo yi
+    yi: פאראייניגטע אראבישע עמיראטן
+    yo: Àwọn Ẹ́mírétì Árábù Aṣọ̀kan
+    zh: 阿拉伯联合酋长国