add mybinder environment.yml

Author: nilsnolde

README.rst

@@ -13,10 +13,15 @@
 .. image:: https://badge.fury.io/py/openrouteservice.svg
     :target: https://badge.fury.io/py/openrouteservice
     :alt: PyPI version
+
 .. image:: https://anaconda.org/nilsnolde/openrouteservice/badges/installer/conda.svg
     :target: https://conda.anaconda.org/nilsnolde/openrouteservice
     :alt: Conda install
 
+.. image:: https://mybinder.org/badge_logo.svg
+    :target: https://mybinder.org/v2/gh/GIScience/openrouteservice-py/master?filepath=examples%2Fbasic_example.ipynb
+    :alt: MyBinder
+
 Quickstart
 ==================================================
 
@@ -111,6 +116,8 @@ If you want to run the unit tests, see Requirements_. ``cd`` to the library dire
 Usage
 ---------------------------------
 
+For an interactive Jupyter notebook have a look on `mybinder.org <https://mybinder.org/v2/gh/GIScience/openrouteservice-py/master?filepath=examples%2Fbasic_example.ipynb>`_.
+
 Basic example
 ^^^^^^^^^^^^^^^^^^^^
 .. code:: python
@@ -147,49 +154,48 @@ By default, the directions API returns `encoded polylines <https://developers.go
 To decode to a ``dict``, which is a GeoJSON geometry object, simply do
 
 .. code:: python
-
     import openrouteservice
-	from openrouteservice import convert
+    from openrouteservice import convert
 
-	coords = ((8.34234,48.23424),(8.34423,48.26424))
+    coords = ((8.34234,48.23424),(8.34423,48.26424))
 
-	client = openrouteservice.Client(key='') # Specify your personal API key
+    client = openrouteservice.Client(key='') # Specify your personal API key
 
-	# decode_polyline needs the geometry only
-	geometry = client.directions(coords)['routes'][0]['geometry']
+    # decode_polyline needs the geometry only
+    geometry = client.directions(coords)['routes'][0]['geometry']
 
-	decoded = convert.decode_polyline(geometry)
+    decoded = convert.decode_polyline(geometry)
 
-	print decoded
+    print decoded
 
 Dry run
 ^^^^^^^^^^^^^^^^^^^^
 Although errors in query creation should be handled quite decently, you can do a dry run to print the request and its parameters:
 
 .. code:: python
 
-	import openrouteservice
+    import openrouteservice
 
-	coords = ((8.34234,48.23424),(8.34423,48.26424))
+    coords = ((8.34234,48.23424),(8.34423,48.26424))
 
-	client = openrouteservice.Client()
-	client.directions(coords, dry_run='true')
+    client = openrouteservice.Client()
+    client.directions(coords, dry_run='true')
 
 Local ORS instance
 ^^^^^^^^^^^^^^^^^^^^
 If you're hosting your own ORS instance, you can alter the ``base_url`` parameter to fit your own:
 
 .. code:: python
 
-	import openrouteservice
+    import openrouteservice
 
-	coords = ((8.34234,48.23424),(8.34423,48.26424))
+    coords = ((8.34234,48.23424),(8.34423,48.26424))
 
-	# key can be omitted for local host
-	client = openrouteservice.Client(base_url='http://localhost/ors')
+    # key can be omitted for local host
+    client = openrouteservice.Client(base_url='http://localhost/ors')
 
-	# Only works if you didn't change the ORS endpoints manually
-	routes = client.directions(coords)
+    # Only works if you didn't change the ORS endpoints manually
+    routes = client.directions(coords)
 
     # If you did change the ORS endpoints for some reason
     # you'll have to pass url and required parameters explicitly:

environment.yml

@@ -0,0 +1,10 @@
+# for https://mybinder.org
+# from https://github.com/binder-examples/python-conda_pip/blob/master/environment.yml
+name: orspy-examples
+channels:
+  - conda-forge
+dependencies:
+  - python
+  - folium
+  - pip:
+    - openrouteservice

openrouteservice/directions.py

@@ -164,6 +164,12 @@ def directions(client,
         of the minified options object. Will be converted to json automatically.
     :type options: dict
 
+    :param optimize_waypoints: If True, a `Vroom <https://github.com/VROOM-Project/vroom>`_ instance (ORS optimization
+        endpoint) will optimize the `via` waypoints, i.e. all coordinates between the first and the last. It assumes
+        the first coordinate to be the start location and the last coordinate to be the end location. Only requests with
+        a minimum of 4 coordinates can be optimized. Default False.
+    :type optimize_waypoints: bool
+
     :param validate: Specifies whether parameters should be validated before sending the request. Default True.
     :type validate: bool