Getting Started with Jupyter Notebooks

The fastest way to get started is to install the JupyterLab Desktop app locally on your computer, and install the Scanner Python SDK into your Jupyter notebook.

Step 1: Download JupyterLab Desktop

Simply download and run the appropriate installer for your OS. You can find download links on the Github page here.

Step 2: Create or open a notebook

Open up the JupyterLab Desktop app. It is often useful to create a directory where you plan to edit your notebooks. Open up that directory in the app, and then create a notebook file.

Step 3: Install the Scanner Python SDK

Run the following command to install the Scanner Python SDK:

pip install scanner-client

Step 4: Import and configure the Scanner API Client

In your Jupyter notebook, run this command to import the Scanner API client:

from scanner_client import Scanner

In the Scanner UI, visit Settings and copy-paste your API URL and API key. We recommend adding them to environment variables like SCANNER_API_URL and SCANNER_API_KEY.

Once that is done, you can create the Scanner API client in your Jupyter notebook:

scanner = Scanner(
    api_url=os.environ["SCANNER_API_URL"],
    api_key=os.environ["SCANNER_API_KEY"],
)

You are now ready to execute queries and perform investigations.