dss-visual-edit

Installation

Visual Edit’s open-source code is hosted in a GitHub repository. As a result, the plugin can be installed via Git or as a ZIP file (installation via Git is recommended as it allows to easily update the plugin when new versions are released). In this guide, we provide details to the steps found in the Dataiku Documentation: Installing plugins.

Requirements

• Compatible version of Dataiku, Python, and compatible SQL data connection. See Compatibility.
• Ability to install plugins on your Dataiku instance.
• Ability to create a code environment.

Option 1: Git

Pre-requisite: GitHub remote repository setup

To connect from Dataiku to this repository, you must add your Dataiku user’s public SSH key to the list of accepted SSH keys in your GitHub account.

• Follow the steps provided in the Dataiku Documentation: Working with Git > Working with remotes > Setup.
• See a more detailed illustration with Dataiku Cloud.

Repository settings

From the Plugins page of your Dataiku instance, once you have clicked on the “Add Plugin” button in the top right corner and chosen “Fetch from Git repository”, use the following settings:

• Repository URL: git@github.com:dataiku/dss-visual-edit.git
• Development mode: leave unticked
• Checkout: choose master under “Branch”, to install the latest version of the plugin; alternatively, choose a version number under “Tag”
• Path in repository: dss-plugin-visual-edit

Option 2: ZIP file

Prepare the plugin ZIP file to upload to your Dataiku instance:

• Find the latest release of the plugin at https://github.com/dataiku/dss-visual-edit/releases. Under Assets, click Source code (zip) to download dss-visual-edit-X.Y.Z.zip (where X.Y.Z is the version number of the release).
• Open the zip file and find the folder dss-plugin-visual-edit.
• Create a zip archive of this folder and name it dss-plugin-visual-edit.zip

From the Plugins page of your Dataiku instance, once you have clicked on the “Add Plugin” button in the top right corner and chosen “Upload”, make sure to choose the dss-plugin-visual-edit.zip archive you just created (do NOT use dss-visual-edit-X.Y.Z.zip).

Creating the code environment

When prompted during the installation procedure, select Python 3.9 and the types of containers you plan to use as backend for Visual Edit webapps or for running recipes provided by the plugin (the easiest is to choose All).

The plugin is installed! You can now follow the guides from the plugin documentation.