src/nominatim_api/__init__.py

   1 # SPDX-License-Identifier: GPL-3.0-or-later
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2024 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 The public interface of the Nominatim library.
   9
  10 Classes and functions defined in this file are considered stable. Always
  11 import from this file, not from the source files directly.
  12 """
  13
  14 # See also https://github.com/PyCQA/pylint/issues/6006
  15 # pylint: disable=useless-import-alias
  16
  17 from .errors import (UsageError as UsageError)
  18 from .config import (Configuration as Configuration)
  19
  20 from .core import (NominatimAPI as NominatimAPI,
  21                    NominatimAPIAsync as NominatimAPIAsync)
  22 from .connection import (SearchConnection as SearchConnection)
  23 from .status import (StatusResult as StatusResult)
  24 from .types import (PlaceID as PlaceID,
  25                     OsmID as OsmID,
  26                     PlaceRef as PlaceRef,
  27                     Point as Point,
  28                     Bbox as Bbox,
  29                     GeometryFormat as GeometryFormat,
  30                     DataLayer as DataLayer)
  31 from .results import (SourceTable as SourceTable,
  32                       AddressLine as AddressLine,
  33                       AddressLines as AddressLines,
  34                       WordInfo as WordInfo,
  35                       WordInfos as WordInfos,
  36                       DetailedResult as DetailedResult,
  37                       ReverseResult as ReverseResult,
  38                       ReverseResults as ReverseResults,
  39                       SearchResult as SearchResult,
  40                       SearchResults as SearchResults)
  41 from .localization import (Locales as Locales)
  42 from .result_formatting import (FormatDispatcher as FormatDispatcher,
  43                                 load_format_dispatcher as load_format_dispatcher)
  44
  45 from .version import NOMINATIM_API_VERSION as __version__