here-search-demo 0.17.6
HERE Geocoding and Search demo and widgets
Requires Python: >=3.10

[![Python package][6]][7]
[![codecov][8]][9]
[![lite-badge][10]][3]


# HERE Search notebooks

A set of jupyter widgets and notebooks demonstrating the use of [HERE Geocoding & Search][4] endpoints `/autosuggest`,  `/discover`, `/browse`, and `/lookup`.

![searching for pizza][11]

Requirements: a [HERE API key][1] and a Python environment. Note that HERE Base Plan [Pricing][5] allows you to get started for free.

| Use Case            | Installation                                          |
|:--------------------|:------------------------------------------------------|
| Online use          | Run the notebooks [in your browser][3]                |
| Local use           | [Install and try locally](#install-and-try-locally)   |
| Package maintenance | [Install from the sources](#install-from-the-sources) |

## 0-install use

`here-search-demo` notebooks are available in a [Github page][3] hosting a JupyterLite instance. 
This allows users to not have to install anything.

## Install and try locally

If you want to use the library and try it through existing notebooks, do:

1. Install the widgets:
   ```shell
   pip install 'here-search-demo[lab]'
   ```
   
2. Grab the notebooks from the [GitHub release asset][12]
3. Add your [HERE API key][1] to `demo-config.json` file.

## Install from the sources

1. `git clone` it and into a `virtualenv`/`venv`, do:
   ```shell
   pip install -r <(sort -u requirements/*) -e '.[dev,lab]'
   ```

2. Copy `demo-config-example.json` to `demo-config.json` and add your [HERE API key][1] to it.

3. Link the virtual environment to a IPython kernel:

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

4. Start either

     - JupyterLab:
       ```shell
       python -m jupyterlab src/here_search/demo/notebooks
       ```
     - or JupyterLite
       ```shell
       bash src/here_search/demo/scripts/lite-run.sh
       ```



(Additional [notes][2])

## License

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

This project is licensed under the MIT license - see the [LICENSE](./LICENSE) file in the root of this project for license details.

[1]: https://www.here.com/docs/bundle/geocoding-and-search-api-developer-guide/page/topics/quick-start.html#get-an-api-key
[2]: https://github.com/heremaps/here-search-demo/blob/main/docs/developers.md
[3]: https://heremaps.github.io/here-search-demo/lab/?path=demo.ipynb
[4]: https://www.here.com/docs/category/geocoding-search-v7
[5]: https://www.here.com/get-started/pricing

[6]: https://github.com/heremaps/here-search-demo/actions/workflows/test.yml/badge.svg
[7]: https://github.com/heremaps/here-search-demo/actions/workflows/test.yml
[8]: https://codecov.io/gh/heremaps/here-search-demo/branch/main/graph/badge.svg?token=MVFCS4BUFN
[9]: https://codecov.io/gh/heremaps/here-search-demo
[11]: https://github.com/heremaps/here-search-demo/raw/main/docs/screenshot.jpg
[10]: https://jupyterlite.rtfd.io/en/latest/_static/badge.svg
[12]: https://github.com/heremaps/here-search-demo/releases/latest/download/here-search-demo-notebooks.zip