druid/docs/tutorials/tutorial-jupyter-index.md

id	title
tutorial-jupyter-index	Jupyter Notebook tutorials

You can try out the Druid APIs using the Jupyter Notebook-based tutorials. These tutorials provide snippets of Python code that you can use to run calls against the Druid API to complete the tutorial.

Prerequisites

Make sure you meet the following requirements before starting the Jupyter-based tutorials:

• Python 3

• The requests package for Python. For example, you can install it with the following command:

  pip3 install requests
  

• JupyterLab (recommended) or Jupyter Notebook running on a non-default port. By default, Druid and Jupyter both try to use port 8888, so start Jupyter on a different port.

  • Install JupyterLab or Notebook:

    # Install JupyterLab
    pip3 install jupyterlab  
    # Install Jupyter Notebook
    pip3 install notebook
    

  • Start Jupyter

    • JupyterLab

      # Start JupyterLab on port 3001
      jupyter lab --port 3001
      

    • Jupyter Notebook

      # Start Jupyter Notebook on port 3001
      jupyter notebook --port 3001
      

• An available Druid instance. You can use the micro-quickstart configuration described in Quickstart (local). The tutorials assume that you are using the quickstart, so no authentication or authorization is expected unless explicitly mentioned.

Tutorials

The notebooks are located in the apache/druid repo. You can either clone the repo or download the notebooks you want individually.

The links that follow are the raw GitHub URLs, so you can use them to download the notebook directly, such as with wget, or manually through your web browser. Note that if you save the file from your web browser, make sure to remove the .txt extension.

• Introduction to the Druid API walks you through some of the basics related to the Druid API and several endpoints.