Concept: External IDE Integrations

In this lesson, you will learn how to edit Dataiku DSS code objects using the integrations with common IDEs, or integrated development environments.

While the Dataiku DSS APIs enable you to code from any IDE, there are also specific integrations with some of the most popular IDEs that allow you to pull, edit, and push back code from existing recipes, plugins, or webapps.

Though Jupyter notebooks are integrated into the Dataiku interface, some developers favor an IDE, such as Visual Studio Code (VS Code), PyCharm, Sublime, RStudio, or IntelliJ.

While these tools are external to the Dataiku interface, you can still use them to connect to a Dataiku instance and edit code recipes, plugins, and in the case of VS Code, webapps.

Slide depicting available IDE integrations.

VS Code Example

Let’s see how this works in practice, using the integration with VS Code as an example.

In order to establish a connection, Dataiku DSS needs to know it can trust your IDE. Within your DSS profile, you can create a personal API key that this instance of DSS will recognize and trust.

In your external IDE, you can then install the Dataiku DSS extension and configure the IDE with your personal API key to connect to your instance of Dataiku DSS.

Screenshot of Dataiku DSS extension in VS Code.

Once the connection is established between the IDE and Dataiku, you can pull code from an existing code recipe, webapp, or plugin into your local IDE.

Within the IDE, you can edit, locally run, and debug code, and then save your code back to the Dataiku DSS instance.

See the video for a demonstration

Alternatives

Note that, with these integrations, you cannot create entirely new recipes, webapps, or plugins – you must edit existing ones.

Alternatively, you can always use the Dataiku DSS APIs in a notebook or IDE to interact with all kinds of DSS objects programmatically.

The integrations with IDEs simply allow you to do this for certain objects without additional programming.

You will learn more about DSS APIs in another course.

What’s Next?

This video introduced the concept of external IDE integrations in Dataiku DSS, using VSCode as an example.

You can read more about the particulars of individual IDEs in the work environment section of the Knowledge Base.