Rename Mapzen service to Pelias

Default to using geocode.earth service URL.
Closes #42.

Author: flibbertigibbet

CHANGES.rst

@@ -192,3 +192,7 @@ v4.0.0, 2017-08-15
 v4.1.0, 2018-03-19
 ------------------
  * Add support for Python 3
+
+v5.0.0, 2018-03-29
+------------------
+ * Rename Mapzen geocoder to Pelias

README.rst

@@ -8,7 +8,7 @@ supported geocoders:
 * `ESRI World Geocoding Service <http://resources.arcgis.com/en/help/arcgis-online-geocoding-rest-api/>`_
 * `MapQuest Licensed Data API <http://developer.mapquest.com/web/products/dev-services/geocoding-ws>`_
 * `MapQuest-hosted Nominatim Open Data API <http://developer.mapquest.com/web/products/open/geocoding-service>`_
-* `Mapzen Search API <https://mapzen.com/projects/search/>`_
+* `Pelias geocoder <https://pelias.io/>`_. Defaults to use `geocode.earth <https://geocode.earth/>`_
 * `Google geocoder <https://developers.google.com/maps/documentation/geocoding/intro>`_
 
 .. NOTE::

omgeo/places.py

@@ -34,9 +34,9 @@ def to_bing_str(self):
         vb = self.convert_srs(4326)
         return '%s,%s,%s,%s' % (vb.bottom, vb.left, vb.top, vb.right)
 
-    def to_mapzen_dict(self):
+    def to_pelias_dict(self):
         """
-        Convert Viewbox object to a string that can be used by Mapzen
+        Convert Viewbox object to a string that can be used by Pelias
         as a query parameter.
         """
         vb = self.convert_srs(4326)

omgeo/services/__init__.py

@@ -3,5 +3,5 @@
 from .us_census import USCensus
 from .mapquest import MapQuest, MapQuestSSL
 from .nominatim import Nominatim
-from .mapzen import Mapzen
+from .pelias import Pelias
 from .google import Google

omgeo/services/mapzen.py omgeo/services/pelias.pyomgeo/services/mapzen.py renamed to omgeo/services/pelias.py

@@ -14,12 +14,12 @@
 logger = logging.getLogger(__name__)
 
 
-class Mapzen(GeocodeService):
+class Pelias(GeocodeService):
     """
-    Class to geocode using `Mapzen search service
-    <https://mapzen.com/projects/search>`_.
+    Class to geocode using `Pelias search service
+    <https://pelias.io/>`_.
 
-    Settings used by the Mapzen GeocodeService object include:
+    Settings used by the Pelias GeocodeService object include:
      * api_key --  The API key used to access search service.
 
     """
@@ -38,16 +38,16 @@ def __init__(self, preprocessors=None, postprocessors=None, settings=None):
         if 'instance_url' in settings:
             self._base_url = settings['instance_url']
         else:
-            self._base_url = 'https://search.mapzen.com'
+            self._base_url = 'https://api.geocode.earth/'
 
         self._default_endpoint = urljoin(self._base_url,
                                          posixjoin(self._api_version, 'search'))
         self._key_endpoint = urljoin(self._base_url,
                                      posixjoin(self._api_version, 'place'))
         self._endpoint = self._default_endpoint
 
-        preprocessors = Mapzen.DEFAULT_PREPROCESSORS if preprocessors is None else preprocessors
-        postprocessors = Mapzen.DEFAULT_POSTPROCESSORS if postprocessors is None else postprocessors
+        preprocessors = Pelias.DEFAULT_PREPROCESSORS if preprocessors is None else preprocessors
+        postprocessors = Pelias.DEFAULT_POSTPROCESSORS if postprocessors is None else postprocessors
         GeocodeService.__init__(self, preprocessors, postprocessors, settings)
 
     def _geocode(self, pq):
@@ -57,7 +57,7 @@ def _geocode(self, pq):
             query = dict(query, **{'boundary.country': pq.country})
 
         if pq.viewbox is not None:
-            box = pq.viewbox.to_mapzen_dict()
+            box = pq.viewbox.to_pelias_dict()
             query = dict(query, **box)
 
         if hasattr(pq, 'key'):

omgeo/tests/tests.py

@@ -14,7 +14,7 @@
 
 BING_MAPS_API_KEY = os.getenv("BING_MAPS_API_KEY")
 MAPQUEST_API_KEY = os.getenv("MAPQUEST_API_KEY")
-MAPZEN_API_KEY = os.getenv("MAPZEN_API_KEY")
+PELIAS_API_KEY = os.getenv("PELIAS_API_KEY")
 GOOGLE_API_KEY = os.getenv("GOOGLE_API_KEY")
 ESRI_CLIENT_ID = os.getenv("ESRI_CLIENT_ID")
 ESRI_CLIENT_SECRET = os.getenv("ESRI_CLIENT_SECRET")
@@ -44,9 +44,8 @@ class GeocoderTest(OmgeoTestCase):
     BING_KEY_REQUIRED_MSG = 'Enter a Bing Maps API key to run the Bing tests.'
     MAPQUEST_KEY_REQUIRED_MSG = 'Enter a MapQuest API key to run the MapQuest tests. '\
                                 'Keys can be obtained at http://developer.mapquest.com/.'
-    MAPZEN_KEY_REQUIRED_MSG = 'Enter a Mapzen Search API key to run Mapzen ' \
-                              'tests. Keys can be obtained at ' \
-                              'https://mapzen.com/developers/sign_in.'
+    PELIAS_KEY_REQUIRED_MSG = 'Enter a Pelias service search API key to run Pelias tests. '\
+                              'Keys can be obtained at https://geocode.earth/.'
     GOOGLE_KEY_REQUIRED_MSG = 'Enter a Google API key to run Google tests.'
     ESRI_KEY_REQUIRED_MSG = 'Enter a Esri Client ID & Secret to run authenticated Esri tests.'
 
@@ -100,9 +99,9 @@ def setUp(self):
             self.g_mapquest_ssl = Geocoder([['omgeo.services.MapQuestSSL',
                                            {'settings': mapquest_settings}]])
 
-        if MAPZEN_API_KEY is not None:
-            mapzen_settings = dict(api_key=MAPZEN_API_KEY)
-            self.g_mapzen = Geocoder([['omgeo.services.Mapzen', {'settings': mapzen_settings}]])
+        if PELIAS_API_KEY is not None:
+            pelias_settings = dict(api_key=PELIAS_API_KEY)
+            self.g_pelias = Geocoder([['omgeo.services.Pelias', {'settings': pelias_settings}]])
 
         if GOOGLE_API_KEY is not None:
             self.g_google = Geocoder([['omgeo.services.Google',
@@ -237,10 +236,10 @@ def test_geocode_mapquest_ssl(self):
         candidates = self.g_mapquest_ssl.get_candidates(self.pq['azavea'])
         self.assertEqual(len(candidates) > 0, True, 'No candidates returned.')
 
-    @unittest.skipIf(MAPZEN_API_KEY is None, MAPZEN_KEY_REQUIRED_MSG)
-    def test_geocode_mapzen(self):
-        """Test Azavea's address using Mapzen geocoder"""
-        candidates = self.g_mapzen.get_candidates(self.pq['azavea'])
+    @unittest.skipIf(PELIAS_API_KEY is None, PELIAS_KEY_REQUIRED_MSG)
+    def test_geocode_pelias(self):
+        """Test Azavea's address using Pelias geocoder"""
+        candidates = self.g_pelias.get_candidates(self.pq['azavea'])
         self.assertEqual(len(candidates) > 0, True, 'No candidates returned.')
 
     @unittest.skip("FIXME")

setup.py

@@ -10,7 +10,7 @@ def read(fname):
 
 setup(
     name="python-omgeo",
-    version="4.1.0",
+    version="5.0.0",
     description="Geocoding Library using ESRI, Bing Maps, and MapQuest geocoders",
     author="Azavea, Inc.",
     author_email="info@azavea.com",

sphinx/conf.py

@@ -48,7 +48,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '4.1.0'
+version = '5.0.0'
 # The full version, including alpha/beta/rc tags.
 release = version
 

sphinx/index.rst

@@ -47,7 +47,7 @@ services
    :members:
    :inherited-members:
 
-.. automodule:: omgeo.services.mapzen
+.. automodule:: omgeo.services.pelias
    :members:
    :inherited-members:
 

test.dummy.sh

@@ -1,7 +1,7 @@
 # RUN AS ROOT
 export BING_MAPS_API_KEY=YOUR_BING_KEY_HERE
 export MAPQUEST_API_KEY=YOUR_MAPQUEST_KEY_HERE
-export MAPZEN_API_KEY=YOUR_MAPZEN_KEY_HERE
+export PELIAS_API_KEY=YOUR_PELIAS_KEY_HERE
 export GOOGLE_API_KEY=YOUR_GOOGLE_KEY_HERE
 export ESRI_CLIENT_ID=YOUR_ESRI_CLIENT_ID_HERE
 export ESRI_CLIENT_SECRET=YOUR_ESRI_CLIENT_SECRET_HERE