# Quick Start

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

[![Join the Etiq Slack User Community](https://518012520-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEPbKmhwsGKY7PeVOfaDr%2Fuploads%2F0hArtFEaBjDHyC8Vm5i5%2Fslack_button-7610f9c51d82009ad912aded124c2d88.svg?alt=media\&token=9115b875-425e-4e2b-956a-88027af99e42)](https://join.slack.com/t/etiqusercommunity/shared_invite/zt-3q79hvvdz-MS1KqV9V142_2CO_AUiUhg)

## 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 Data Science Copilot 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 ](https://code.visualstudio.com/docs/python/environments#_working-with-python-interpreters)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

<figure><img src="https://518012520-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEPbKmhwsGKY7PeVOfaDr%2Fuploads%2FJfRclXsrMdO2sexjlB4R%2FScreenshot%202025-10-27%20at%2007.20.00.png?alt=media&#x26;token=27d99567-f5ba-4d9e-98f0-5d3ba9c4b064" alt=""><figcaption></figcaption></figure>

### 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.

* <kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>P</kbd> (Mac) / <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux).

  Note that this command is a reserved keyboard shortcut in Firefox.
* <kbd>F1</kbd>
* From the Application Menu, click **View > Command Palette**.

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

<figure><img src="https://518012520-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEPbKmhwsGKY7PeVOfaDr%2Fuploads%2FSBGvOWvvhvI7tSVk5z7P%2Fetiq-panel-vscode.png?alt=media&#x26;token=3d8e3f93-eca0-4ba1-abfa-f831987dc4dd" alt=""><figcaption><p>Searching for the Etiq Panel in the Command Palette</p></figcaption></figure>

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

<figure><img src="https://518012520-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEPbKmhwsGKY7PeVOfaDr%2Fuploads%2F1tUWJdOjdOUmxOpSLDYw%2Fready-to-scan-vscode.png?alt=media&#x26;token=072f3163-2e8e-4b59-beeb-a055c624a220" alt=""><figcaption><p>Showing the Etiq Panel</p></figcaption></figure>

### Exposing the Etiq Output Pane

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

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

Select `Etiq` from the highlighted dropdown box

<figure><img src="https://518012520-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEPbKmhwsGKY7PeVOfaDr%2Fuploads%2FlCKBZFYuIHeszvd0O6o2%2Fvscode-output-example.png?alt=media&#x26;token=9fa98dfb-e9e0-475d-a689-1c3d0d48db5e" alt=""><figcaption><p>Output pane from VSCode with highlighted dropdown</p></figcaption></figure>

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.

<figure><img src="https://518012520-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEPbKmhwsGKY7PeVOfaDr%2Fuploads%2FFHQKvhnldiPMXEi9Tjcw%2Flineage-example-vscode.png?alt=media&#x26;token=f2bdf0ff-7ba5-4308-b83e-3da65c43230f" alt=""><figcaption><p>A successfully scanned script and Lineage</p></figcaption></figure>

## 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

<figure><img src="https://518012520-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEPbKmhwsGKY7PeVOfaDr%2Fuploads%2FoVySnnK8H37WRmVoumdk%2Ftest-script-jupyterlab.png?alt=media&#x26;token=90c0a887-2b8d-4ffe-8587-af7ad064b248" alt="a test notebook open"><figcaption></figcaption></figure>

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

<figure><img src="https://518012520-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEPbKmhwsGKY7PeVOfaDr%2Fuploads%2Fk2KkKFVBYKZRLbd0H0le%2Fopen-lineage-tab-jupyterlab.png?alt=media&#x26;token=cc92c2a9-cdba-49e4-8605-1b6ba580fb3a" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://518012520-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEPbKmhwsGKY7PeVOfaDr%2Fuploads%2FEx3TXOzWgEW6dK6R6PqC%2Frun-full-lineage-jupyterlab.png?alt=media&#x26;token=5f045990-e6a6-4a5a-8112-c2c8d846fc59" alt=""><figcaption></figcaption></figure>

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.

<figure><img src="https://518012520-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEPbKmhwsGKY7PeVOfaDr%2Fuploads%2FOWwnw6FUDJATlsrPrE5b%2Fcell-lineage-jupyterlab.png?alt=media&#x26;token=6a67c6bc-6e9b-44c4-8a9a-f81182adb39f" alt=""><figcaption></figcaption></figure>
