Quick Start

Requirements

Python 3.9 - 3.12

We currently support the VSCode IDE with our extension

Jupyter Notebook integration coming soon!

Installation

Unzip the Etiq Installation package to a folder

In VSCode create a new folder and new virtual environment

Install the relevant version of the etiq_wheels

Install the relevant version of the etiq2_wheels

From VSCode right click on the extracted etiq-vscode-extension-*.vsix file and Install from VSIX

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

Select Etiq from the highlighted dropdown box

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

Starting Etiq in VSCode

There is an example script within the installation package called 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

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

Scanning a file - Creating your first lineage

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.