Add more documentation

docs/index.rst

@@ -82,6 +82,8 @@ Detailed information about each individual provider that are within Geocoder.
     providers/IPInfo.rst
     providers/TomTom.rst
     providers/What3Words.rst
+    providers/Yahoo.rst
+    providers/Yandex.rst
 
 
 Contributor Guide

docs/providers/Mapbox.rst

@@ -42,21 +42,22 @@ To make sure your API key is store safely on your computer, you can define that
 
 .. code-block:: bash
 
-    $ export MAPBOX_ACCESS_TOKEN=XXXXXXXXXX
+    $ export MAPBOX_ACCESS_TOKEN=secret_access_token
+    $ heroku config:set MAPBOX_ACCESS_TOKEN=secret_access_token
 
 Parameters
-----------
+~~~~~~~~~~
 
 - `location`: Your search location you want geocoded.
 - `proximity`: Search nearby [lat, lng].
-- `method`: (default=geocode) Use the following:
 - `access_token`: use your own access token from Mapbox.
+- `method`: (default=geocode) Use the following:
 
   - geocode
   - reverse
 
 References
-----------
+~~~~~~~~~~
 
 - `Mabpox Geocoding API <https://www.mapbox.com/developers/api/geocoding/>`_
 - `Get Mabpox Access Token <https://www.mapbox.com/account>`_

docs/providers/TomTom.rst

@@ -37,7 +37,7 @@ To make sure your API key is store safely on your computer, you can define that
     $ export TOMTOM_API_KEY=XXXXXXXXXX
 
 Parameters
-----------
+~~~~~~~~~~
 
 - `location`: Your search location you want geocoded.
 - `key`: use your own API Key from TomTom.
@@ -46,6 +46,6 @@ Parameters
   - geocode
 
 References
-----------
+~~~~~~~~~~
 
-- `TomTom Geocoding API <http://developer.tomtom.com/products/geocoding_api`_
+- `TomTom Geocoding API <http://developer.tomtom.com/products/geocoding_api>`_

docs/providers/Yahoo.rst

@@ -0,0 +1,40 @@
+Yahoo
+=====
+
+Yahoo PlaceFinder is a geocoding Web service that helps developers make
+their applications location-aware by converting street addresses or
+place names into geographic coordinates (and vice versa).
+Using Geocoder you can retrieve Yahoo's geocoded data from Yahoo BOSS Geo Services.
+
+Examples
+~~~~~~~~
+
+Basic Geocoding
+---------------
+
+.. code-block:: python
+
+    >>> import geocoder
+    >>> g = geocoder.yahoo('San Francisco, CA')
+    >>> g.json
+    ...
+
+Command Line Interface
+----------------------
+
+.. code-block:: bash
+
+    $ geocode 'San Francisco, CA' --provider yahoo --out geojson
+
+Parameters
+~~~~~~~~~~
+
+- `location`: Your search location you want geocoded.
+- `method`: (default=geocode) Use the following:
+
+  - geocode
+
+References
+~~~~~~~~~~
+
+- `Yahoo BOSS Geo Services <https://developer.yahoo.com/boss/geo/>`_

docs/providers/Yandex.rst

@@ -0,0 +1,70 @@
+Yandex
+======
+
+Yandex (Russian: Яндекс) is a Russian Internet company which operates the
+largest search engine in Russia with about 60% market share in that country.
+
+The Yandex home page has been rated as the most popular website in Russia.
+
+Examples
+~~~~~~~~
+
+Basic Geocoding
+---------------
+
+.. code-block:: python
+
+    >>> import geocoder
+    >>> g = geocoder.yandex('Moscow Russia')
+    >>> g.json
+    ...
+
+Reverse Geocoding
+-----------------
+
+.. code-block:: python
+
+    >>> import geocoder
+    >>> g = geocoder.mapbox([55.95, 37.96], method='reverse')
+    >>> g.json
+    ...
+
+Command Line Interface
+----------------------
+
+.. code-block:: bash
+
+    $ geocode 'Moscow Russia' --provider yandex --out geojson
+    $ geocode '55.95, 37.96' --provider yandex --method reverse
+
+Parameters
+----------
+
+- `location`: Your search location you want geocoded.
+- `location`: Your search location you want geocoded.
+- `lang`: Chose the following language:
+
+    - **ru-RU** — Russian (by default)
+    - **uk-UA** — Ukrainian
+    - **be-BY** — Belarusian
+    - **en-US** — American English
+    - **en-BR** — British English
+    - **tr-TR** — Turkish (only for maps of Turkey)
+
+- `kind`: Type of toponym (only for reverse geocoding):
+
+    - **house** — house or building
+    - **street** — street
+    - **metro** — subway station
+    - **district** — city district
+    - **locality** — locality (city, town, village, etc.)
+
+- `method`: (default=geocode) Use the following:
+
+    - geocode
+    - reverse
+
+References
+----------
+
+- `Yandex API Reference <http://api.yandex.com/maps/doc/geocoder/desc/concepts/input_params.xml>`_

geocoder/__init__.py

@@ -28,7 +28,7 @@
 __title__ = 'geocoder'
 __author__ = 'Denis Carriere'
 __author_email__ = '[email protected]'
-__version__ = '1.5.3'
+__version__ = '1.6.0'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2013-2015 Denis Carriere'
 

setup.py

@@ -9,7 +9,6 @@
 except ImportError:
     from distutils.core import setup
 
-
 version = ''
 with open('geocoder/__init__.py', 'r') as fd:
     version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]',
@@ -63,6 +62,6 @@
         'Topic :: Internet',
         'Topic :: Internet :: WWW/HTTP',
         'Topic :: Scientific/Engineering :: GIS',
-        'Topic :: Software Development :: Libraries :: Python Modules'
+        'Topic :: Software Development :: Libraries :: Python Modules',
     ),
 )