Extension How To

Quick install: Etiq Extension for VSCode and Jupyter Notebook.

Have any questions or looking for support from the team, join our Slack User Community:

Requirements

Python 3.10 - 3.13

We currently support the VSCode IDE and Jupyter Notebooks with our extension

Installation

In order to use the Etiq Extensions you need to install the Python package to your local environment, then one of the VSCode Extension or the JupyterLab Extension depending on your IDE of choice.

Python Package

Install the etiq-copilot python package from PyPi:

pip install etiq-copilot

VSCode Extension

Download the VSCode extension from the VSCode Marketplace, either search for Etiq in the Extensions pane on your VSCode or via the link below:

https://marketplace.visualstudio.com/items?itemName=ETIQAI.etiq-vscode-extension&ssr=false#overview

JupyterLab Extension

Install the jupyterlab-etiq python package from PyPi:

pip install jupyterlab-etiq

Getting Started with Etiq in VSCode

⚠️ Warning! Please be sure that you have selected the correct Python Interpreter in your VSCode, this should be the venv or other virtual environment where etiq-copilot was installed. If you see an error like the below you are that is likely to be the issue

Starting Etiq in VSCode

We recommend you start with the example scripts available on our Github here:

https://github.com/ETIQ-AI/etiq-demo-scripts.git

Within the lineage_example directory you'll find lineage_example.py

Open that file in your VSCode window

Open the VSCode command palette.

You can access the VS Code Command Palette in a number of ways.

• Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).

  Note that this command is a reserved keyboard shortcut in Firefox.

• F1

• From the Application Menu, click View > Command Palette.

Type into the search bar etiq and select etiq: Show Panel

Searching for the Etiq Panel in the Command Palette

This will then bring up the Etiq Extension to the right of your code in VSCode as below

Showing the Etiq Panel

Exposing the Etiq Output Pane

By opening the Etiq Output Pane, it allows you to see what Etiq is doing.

View Output: Shift+Command+O (Mac) / Ctrl+Shift+O (Windows/Linux).

Select Etiq from the highlighted dropdown box

Output pane from VSCode with highlighted dropdown

Once you can see Listening on port 5556 in the window you are ready to scan your first script!

Scanning a file - Creating your first lineage in VSCode

With your script open on the left, click Scan the current file in the Etiq extension on the right. This will then scan your code and data and show you your Lineage in the Lineage pane.

A successfully scanned script and Lineage

Getting Started with Etiq in JupyterLab

Starting Etiq in JupyterLab

We recommend you start with the example scripts available on our Github here:

https://github.com/ETIQ-AI/etiq-demo-scripts.git

Within the lineage_example directory you'll find lineage_example.ipynb

Open this in your Jupyter Notebook Server

Scanning a file - Creating your first lineage in JupyterLab

You can then open the sidebar on the right on the Lineage tab

If you now click the Scan file button within this tab, Etiq will analyse the entire notebook and display the lineage.

You can also select an individual cell, ensuring that previous cells have been executed, and display the lineage just for the data and code objects in that cell.