HERE Search demo

Package version: 0.35.1

A set of widgets and notebooks demonstrating

• the use of HERE Geocoding & Search endpoints /autosuggest, /discover, /browse, /lookup and /signals.
• the integration of HERE Routing for search along the route use cases.

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.

I want to...	Recommended path
Try online interactive notebooks
Use notebooks locally in a Python setup	Offline notebooks
Contribute or run full project workflows	Contribute

Online documentation with interactive notebooks is available here.

Offline notebooks

1. Install the package in the virtual environment of your choice (Python 3.13 recommended):

   pip install 'here-search-demo[lab]'
   

2. Extract notebooks and credentials.properties.txt from here-search-demo.zip in to the same directory.
3. Update credentials.properties.txt with your HERE credentials.
4. Create a ipykernel for the package:

   prefix=$(python -c "import sys; print(sys.prefix)")
   python -m ipykernel install --prefix $prefix --name search_demo --display-name "search demo"
   

5. Start JupyterLab:

   python -m jupyterlab
   

Contribute

1. Clone the repository and install dependencies:

   uv pip install -e '.[dev,docs,lab]'
   

   Also install [micromamba][micromamba].
2. Run tests:

   pytest -n auto --ignore=tests/test_notebooks.py
   

3. Build the JupyterLite static page:

   jupyterlite_build/xeus.sh
   

3b. JupyterLab alternative:

prefix=$(python -c "import sys; print(sys.prefix)")
python -m ipykernel install --prefix $prefix --name search_demo --display-name "search demo"

Then:

python -m jupyterlab notebooks

4. Build the docs page:

   sphinx-build -b html docs/ workspace/public/docs
   

(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.

Note: This MIT-licensed project uses only open-source, community-maintained tools—such as JupyterLite, xeus kernels, micromamba, and packages from conda-forge and emscripten-forge-dev—and includes no Anaconda-distributed components. Each dependency remains under its own open-source license; see their LICENSE files for details.