Setup and Test Kedro-Viz in VSCode - Githubissues

kedro-org / vscode-kedro

Kedro extension for VSCode including LSP and other features

https://marketplace.visualstudio.com/items?itemName=kedro.Kedro

Apache License 2.0

18 stars 2 forks source link

Setup and Test Kedro-Viz in VSCode #120

Open jitu5 opened 2 months ago

jitu5 commented 2 months ago

Requirements:

VS Code 1.64.0 or greater
Python extension for VS Code
Kedro Project >= 0.19

Pre-requisite:

The extension requires bootstrap_project in Kedro. You need to ensure that you can run kedro run without encountering any immediate errors; otherwise, you may experience a server panic error.
Select the correct Python interpreter that you use to run the Kedro project by pressing Shift + Cmd + P, typing “Python: Select Interpreter,” and hitting Enter.

Setup:

You can install pre-release version of extension from marketplace directly
Restart the extension or VSCode window by pressing Shift + Cmd + P, typing ‘Developer: Reload Window,’ and hitting Enter.
If you are using the Kedro extension for the first time, note that it will only activate when you open a .yml or .py file in the editor.

Check:

To check if the Kedro extension is running properly, navigate to Output and select Kedro from the drop-down menu.
It may provide hints and report errors. If errors appear, press Cmd + Shift + P to open the VSCode command palette and search for Kedro: Restart Server.
If there are no errors, open a pipeline.py file from your Kedro project and hover over any input or output values to see their details.

Visualize:

To visualize the Kedro pipeline, press Shift + Cmd + P, type ‘Kedro: Run Kedro Viz,’ and hit Enter.

Test Case 1:

If you do not have Kedro-Viz 10.0.0 installed in your virtual environment, you will be prompted to install it.
If you click on “Install,” you will see a loader notification while the installation is in progress.
Once installation is complete, the Kedro-Viz flowchart will appear.
If you click “Cancel,” a notification will appear, and the operation will be canceled.

Test Case 2:

Once the flowchart loads successfully, click on any data node to navigate to the corresponding .ymlfile.

Test Case 3:

Once the flowchart loads successfully, click on any function node to navigate to the corresponding .py file.

Test Case 4:

Make some changes to your Kedro project that can be visualised in the flowchart (after changes, ensure that you can run kedro run without any immediate errors).
To reflect your changes in the flowchart, press Cmd + Shift + P, search for Kedro: Restart Server, and hit Enter.

Test Case 5:

Please repeat above steps for other Kedro project.

rashidakanchwala commented 2 months ago

I tried the above. All scenarios work for me. Thanks!