Merge pull request #421 from geopy/v2/osm-to-nominatim

geopy 2.0: rename `osm` module to `nominatim`

CONTRIBUTING.md

@@ -116,7 +116,7 @@ A checklist for adding a new geocoder:
     `geopy/geocoders` package. Please look around to make sure that you're
     not reimplementing something that's already there! For example, if you're
     adding a Nominatim-based service, then your new geocoder class should
-    probably extend the `geopy.geocoders.osm.Nominatim` class.
+    probably extend the `geopy.geocoders.Nominatim` class.
 
 2.  Follow the instructions in the `geopy/geocoders/__init__.py` module for
     adding the required imports.

docs/changelog_2xx.rst

@@ -17,7 +17,7 @@ If you have checked your code on the latest 1.x release with enabled
 warnings (i.e. with ``-Wd`` key of the ``python`` command) and fixed
 all of them, then it should be safe to upgrade.
 
-New features
+New Features
 ~~~~~~~~~~~~
 
 - :mod:`geopy.adapters` module. Previously all geocoders used :mod:`urllib`
@@ -41,7 +41,7 @@ New features
 - :class:`.AsyncRateLimiter` -- an async counterpart of :class:`.RateLimiter`.
 - :class:`.RateLimiter` is now thread-safe.
 
-Packaging changes
+Packaging Changes
 ~~~~~~~~~~~~~~~~~
 
 - Dropped support for Python 2.7 and 3.4.
@@ -50,8 +50,8 @@ Packaging changes
   + ``geopy[requests]`` for :class:`geopy.adapters.RequestsAdapter`.
   + ``geopy[aiohttp]`` for :class:`geopy.adapters.AioHTTPAdapter`.
 
-Chores
-~~~~~~
+Breaking Changes
+~~~~~~~~~~~~~~~~
 
 - ``geopy.distance`` algorithms now raise ``ValueError`` for points with
   different altitudes, because :ref:`altitude is ignored in calculations
@@ -87,3 +87,10 @@ Chores
   :class:`.GeoNames`, :class:`.OpenMapQuest` and :class:`.Yandex`.
 - ``parse_*`` methods in geocoders have been prefixed with ``_``
   to explicitly mark that they are private.
+
+Deprecations
+~~~~~~~~~~~~
+
+- :class:`.Nominatim` has been moved from ``geopy.geocoders.osm`` module
+  to ``geopy.geocoders.nominatim``. The old module is still present for
+  backwards compatibility, but it will be removed in geopy 3.

geopy/geocoders/__init__.py

@@ -204,10 +204,10 @@
     "MapBox",
     "MapQuest",
     "MapTiler",
+    "Nominatim",
     "OpenCage",
     "OpenMapQuest",
     "PickPoint",
-    "Nominatim",
     "Pelias",
     "Photon",
     "LiveAddress",
@@ -236,9 +236,9 @@
 from geopy.geocoders.mapbox import MapBox
 from geopy.geocoders.mapquest import MapQuest
 from geopy.geocoders.maptiler import MapTiler
+from geopy.geocoders.nominatim import Nominatim
 from geopy.geocoders.opencage import OpenCage
 from geopy.geocoders.openmapquest import OpenMapQuest
-from geopy.geocoders.osm import Nominatim
 from geopy.geocoders.pelias import Pelias
 from geopy.geocoders.photon import Photon
 from geopy.geocoders.pickpoint import PickPoint
@@ -267,10 +267,10 @@
     "mapbox": MapBox,
     "mapquest": MapQuest,
     "maptiler": MapTiler,
+    "nominatim": Nominatim,
     "opencage": OpenCage,
     "openmapquest": OpenMapQuest,
     "pickpoint": PickPoint,
-    "nominatim": Nominatim,
     "pelias": Pelias,
     "photon": Photon,
     "liveaddress": LiveAddress,
@@ -286,7 +286,7 @@ def get_geocoder_for_service(service):
 
     >>> from geopy.geocoders import get_geocoder_for_service
     >>> get_geocoder_for_service("nominatim")
-    geopy.geocoders.osm.Nominatim
+    geopy.geocoders.nominatim.Nominatim
 
     If the string given is not recognized, a
     :class:`geopy.exc.GeocoderNotFound` exception is raised.