bump version to 0.1.1

Signed-off-by: Kharude, Sachin <[email protected]>

.github/workflows/main.yml

@@ -67,6 +67,12 @@ jobs:
       shell: bash -l {0}
       run: python -c 'import here_map_widget'
 
+    - name: Build the package (Only on Linux for saving time)
+      if: matrix.os == 'ubuntu-latest'
+      shell: bash -l {0}
+      run: |
+        python setup.py sdist bdist_wheel
+
     - name: Build docs (Only on Linux for saving time)
       if: matrix.os == 'ubuntu-latest'
       shell: bash -l {0}

README.md

@@ -1,36 +1,44 @@
 # HERE Map Widget for Jupyter
 
+![Tests](https://github.com/heremaps/here-map-widget-for-jupyter/workflows/Tests/badge.svg)
+[![PyPI - Status](https://img.shields.io/pypi/status/here-map-widget-for-jupyter)](https://pypi.org/project/here-map-widget-for-jupyter/)
+[![PyPI - Python Version](https://img.shields.io/pypi/v/here-map-widget-for-jupyter.svg?logo=pypi)](https://pypi.org/project/here-map-widget-for-jupyter/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/here-map-widget-for-jupyter)](https://pypi.org/project/here-map-widget-for-jupyter/)
+[![PyPI - License](https://img.shields.io/pypi/l/here-map-widget-for-jupyter)](https://pypi.org/project/here-map-widget-for-jupyter/)
+[![Downloads](https://pepy.tech/badge/here-map-widget-for-jupyter)](https://pepy.tech/project/here-map-widget-for-jupyter)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/heremaps/here-map-widget-for-jupyter/master?urlpath=lab/tree/examples)
+
 Use [HERE Maps API for JavaScript](https://developer.here.com/develop/javascript-api) in your [Jupyter Notebook](https://jupyter.org/).
 
 ## Usage
 
 **Selecting a basemap:**
 
-![Select base map](images/basemaps.gif)
+![Select base map](https://github.com/heremaps/here-map-widget-for-jupyter/raw/master/images/basemaps.gif)
 
 **Loading a GeoJSON data on a map:**
 
-![Use GeoJSON on map](images/geojson.gif)
+![Use GeoJSON on map](https://github.com/heremaps/here-map-widget-for-jupyter/raw/master/images/geojson.gif)
 
 **Making use of HERE Maps API for JavaScript primitives such as Marker to draw a SVG icon on the map:**
 
-![Add marker to map](images/marker.gif)
+![Add marker to map](https://github.com/heremaps/here-map-widget-for-jupyter/raw/master/images/marker.gif)
 
 **Using the search control to search GeoJSON layer data:**
 
-![Add search control to map](images/search-control.gif)
+![Add search control to map](https://github.com/heremaps/here-map-widget-for-jupyter/raw/master/images/search-control.gif)
 
 **Displaying [GeoPandas](https://geopandas.org/) data on map:**
 
-![Add Geopandas data to map](images/geo-pandas.gif)
+![Add Geopandas data to map](https://github.com/heremaps/here-map-widget-for-jupyter/raw/master/images/geo-pandas.gif)
 
 **Displaying [XYZ Hub](https://github.com/heremaps/xyz-hub) or [HERE Data Hub](https://developer.here.com/products/data-hub) space data on a map:**
 
-![Add XYZ data to map](images/xyz.gif)
+![Add XYZ data to map](https://github.com/heremaps/here-map-widget-for-jupyter/raw/master/images/xyz.gif)
 
 **Use [ipywidgets](https://ipywidgets.readthedocs.io/) controls to build an interactive GUI:**
 
-![Add ipywidgets controls](images/widget-control.gif)
+![Add ipywidgets controls](https://github.com/heremaps/here-map-widget-for-jupyter/raw/master/images/widget-control.gif)
 
 ## Prerequisites
 

binder/environment.yml

@@ -0,0 +1,12 @@
+name: here_map_widget
+channels:
+  - conda-forge
+dependencies:
+  - pip
+  - xyzspaces
+  - jupyterlab==2.2.9
+  - pip:
+    - "-r ../requirements.txt"
+    - "-r ../requirements_dev.txt"
+    - "-r ../docs/requirements.txt"
+    - "-e ../"

binder/postBuild

@@ -0,0 +1,9 @@
+npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/here-node/
+jupyter nbextension install --py --symlink --sys-prefix here_map_widget
+jupyter nbextension enable --py --sys-prefix here_map_widget
+jupyter labextension install @jupyter-widgets/jupyterlab-manager js
+
+# Notebooks with extensions that auto-run code must be "trusted" to work the first time
+jupyter trust examples/*.ipynb
+
+jupyter lab build --dev-build=False --minimize=False

docs/source/installation.rst

@@ -139,6 +139,4 @@ Installation Example
           - Validating: OK
 
     $ jupyter labextension install @jupyter-widgets/jupyterlab-manager @here/maps-api-for-javascript-widget-for-jupyter-noteboo
-    Building jupyterlab assets (build:prod:minimize)
-
-    $ npm config delete @here:registry https://repo.platform.here.com/artifactory/api/npm/here-node/
+    Building jupyterlab assets (build:prod:minimize)

examples/README.md

@@ -2,6 +2,12 @@
 
 The example notebooks in this directory demonstrate various functionalities of `HERE Map Widget for Jupyter`.
 
+## Prerequisites
+Before you run the Notebooks make sure you have:
+- A HERE developer account, free and available under [HERE Developer Portal](https://developer.here.com)
+- An [API key](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/dev-apikey.html) from the [HERE Developer Portal](https://developer.here.com)
+- An XYZ API access token from your XYZ Hub server or the [XYZ portal](https://www.here.xyz) see also it's [Getting
+  Started](https://www.here.xyz/getting-started/).
 ## Notebooks
 
 - [Add ipywidgets over map](./add_ipywidgets.ipynb) - Display interactive ipywidget over map and control traits of the map.

examples/add_ipywidgets.ipynb

@@ -1,5 +1,25 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-warning\">\n",
+    "<b>Warning:</b> Before running below cells please make sure you have API key. \n",
+    "                Please see <a href=\"https://github.com/heremaps/here-map-widget-for-jupyter/blob/master/examples/README.md\">README.md</a> for more info on API key.\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"LS_API_KEY\"] = \"MY-API-KEY\" # replace your API key here."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -61,7 +81,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.7.9"
   }
  },
  "nbformat": 4,

examples/basemaps.ipynb

@@ -1,5 +1,25 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-warning\">\n",
+    "<b>Warning:</b> Before running below cells please make sure you have API key. \n",
+    "                Please see <a href=\"https://github.com/heremaps/here-map-widget-for-jupyter/blob/master/examples/README.md\">README.md</a> for more info on API key.\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"LS_API_KEY\"] = \"MY-API-KEY\" # replace your API key here."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -160,7 +180,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.7.9"
   }
  },
  "nbformat": 4,

examples/choropleth_layer.ipynb

@@ -1,5 +1,25 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-warning\">\n",
+    "<b>Warning:</b> Before running below cells please make sure you have API key. \n",
+    "                Please see <a href=\"https://github.com/heremaps/here-map-widget-for-jupyter/blob/master/examples/README.md\">README.md</a> for more info on API key.\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"LS_API_KEY\"] = \"MY-API-KEY\" # replace your API key here."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -161,7 +181,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.7.9"
   }
  },
  "nbformat": 4,

examples/circle.ipynb

@@ -1,5 +1,25 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-warning\">\n",
+    "<b>Warning:</b> Before running below cells please make sure you have API key. \n",
+    "                Please see <a href=\"https://github.com/heremaps/here-map-widget-for-jupyter/blob/master/examples/README.md\">README.md</a> for more info on API key.\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"LS_API_KEY\"] = \"MY-API-KEY\" # replace your API key here."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -39,7 +59,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.7.9"
   }
  },
  "nbformat": 4,

examples/custom_icons.ipynb

@@ -1,5 +1,25 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-warning\">\n",
+    "<b>Warning:</b> Before running below cells please make sure you have API key. \n",
+    "                Please see <a href=\"https://github.com/heremaps/here-map-widget-for-jupyter/blob/master/examples/README.md\">README.md</a> for more info on API key.\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"LS_API_KEY\"] = \"MY-API-KEY\" # replace your API key here."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -61,7 +81,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.7.9"
   }
  },
  "nbformat": 4,

examples/custom_marker_icon.ipynb

@@ -1,5 +1,25 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-warning\">\n",
+    "<b>Warning:</b> Before running below cells please make sure you have API key. \n",
+    "                Please see <a href=\"https://github.com/heremaps/here-map-widget-for-jupyter/blob/master/examples/README.md\">README.md</a> for more info on API key.\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"LS_API_KEY\"] = \"MY-API-KEY\" # replace your API key here."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -45,7 +65,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.7.9"
   }
  },
  "nbformat": 4,

examples/datahub_space.ipynb

@@ -1,12 +1,24 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-warning\">\n",
+    "<b>Warning:</b> Before running below cells please make sure you have API key and XYZ access token. \n",
+    "                Please see <a href=\"https://github.com/heremaps/here-map-widget-for-jupyter/blob/master/examples/README.md\">README.md</a> for more info on API key and XYZ access token.\n",
+    "</div>"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
-    "#! pip install xyzspaces"
+    "import os\n",
+    "os.environ[\"LS_API_KEY\"] = \"MY-API-KEY\" # replace your API key here.\n",
+    "os.environ[\"XYZ_TOKEN\"] = \"MY-XYZ-TOKEN\" # replace your XYZ access token here."
    ]
   },
   {
@@ -107,7 +119,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.7.9"
   }
  },
  "nbformat": 4,

examples/datahub_space_style.ipynb

@@ -1,5 +1,26 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-warning\">\n",
+    "<b>Warning:</b> Before running below cells please make sure you have API key and XYZ access token. \n",
+    "                Please see <a href=\"https://github.com/heremaps/here-map-widget-for-jupyter/blob/master/examples/README.md\">README.md</a> for more info on API key and XYZ access token.\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"LS_API_KEY\"] = \"MY-API-KEY\" # replace your API key here.\n",
+    "os.environ[\"XYZ_TOKEN\"] = \"MY-XYZ-TOKEN\" # replace your XYZ access token here."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -59,7 +80,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.7.9"
   }
  },
  "nbformat": 4,