Skip to content

heremaps/here-search-demo

Repository files navigation

Python package codecov xeus-badge pyodide-badge

HERE Search demo

A set of widgets and notebooks demonstrating the use of HERE Geocoding & Search endpoints /autosuggest, /discover, /browse, /lookup and /signals.

Requirements: HERE credentials (both API key and Oauth2 key/secret) and a Python environment. Note that HERE Base Plan Pricing allows you to get started for free.

Use Case Installation
Online use Run the notebooks in your browser
Local use Install and try locally
Development Install from the sources

0-install use

here-search-demo notebooks are available for immediate use in a Github page hosting a JupyterLite instance based on the xeus stack (CPython running on xeus-python kernel).

A version of these pages based on the Pyodide stack and the jupyterlite-pyodide-kernel is also available here.

Install and try locally

If you want to use the library and notebooks in a local JupyterLab, do:

  1. Install the widgets into a virtualenv/venv:

    uv pip install 'here-search-demo[lab,route]'
  2. Extract the notebooks and credentials.properties the GitHub release asset

  3. Keep credentials.properties in the same directory as the notebooks and update it with your HERE credentials.

  4. Link the virtual environment to a IPython kernel:

    python -m ipykernel install \
      --prefix $(python -c "import sys; print(sys.prefix)") \
      --name search_demo --display-name "search demo"
  5. Start JupyterLab and browse to the notebooks' directory:

    python -m jupyterlab

Install from the sources

If you need to maintain this package:

  1. git clone it and into a virtualenv/venv, do:

    uv pip install -e '.[dev,lab,route]'
  2. Copy example-credentials.properties to notebooks/credentials.properties and update it with your HERE credentials.

  3. Link the virtual environment to a IPython kernel:

    python -m ipykernel install \
      --prefix $(python -c "import sys; print(sys.prefix)") \
      --name search_demo --display-name "search demo"
  4. Run the tests to check the installation:

    pytest -v
  5. Start either

    • JupyterLab:
      python -m jupyterlab notebooks
    • or JupyterLite
      bash scripts/lite-build.sh

(Additional notes)

License

Copyright (C) 2022-2026 HERE Europe B.V.

This project is licensed under the MIT license - see the LICENSE file in the root of this project for license details.