https://github.com/dataiku/dss-integration-vscode
Extension for Visual Studio Code to develop Recipes, Plugins and Web Apps outside DSS
https://github.com/dataiku/dss-integration-vscode
Last synced: 6 days ago
JSON representation
Extension for Visual Studio Code to develop Recipes, Plugins and Web Apps outside DSS
- Host: GitHub
- URL: https://github.com/dataiku/dss-integration-vscode
- Owner: dataiku
- License: apache-2.0
- Created: 2019-06-07T10:37:16.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-27T11:41:48.000Z (about 3 years ago)
- Last Synced: 2023-03-30T13:14:14.986Z (about 3 years ago)
- Language: TypeScript
- Size: 733 KB
- Stars: 4
- Watchers: 39
- Forks: 0
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Dataiku DSS Visual Studio Code Extension
Easily edit code Recipes, code Libraries, Web App files and Plugin files of your DSS projects right into VSCode.
## Features
The extension offers a new menu in the left panel (with the Dataiku logo). Through it, you can browse your projects and plugins.
Depending on the version of your DSS instance, some features might not be available.
#### Code Recipe
You can browse all code recipe of a project, edit them and when you save them, they will be saved back into DSS.
When a code recipe is open you will find in the bottom bar a button to run this recipe remotely on DSS. A new *Output* window will open and print the log of the running recipe.
### Wiki
You can browse all wiki articles of a project, create, remove, edit and save them back into DSS.
### Libraries
You can browse all files in the code libraries of a project. You can then add, remove or edit these files and the changes will be reflected into DSS.
#### Plugins
You can browse into your plugins' hierarchy, edit the files and when you save them, they will be saved back into DSS.
When you select a folder, a new icon will appear to let you add new files in this folder.
#### Code Recipe
Python and R recipe can be **run locally**. To do so you will need:
- to have the *dataiku* package installed on your machine: to install it, follow the instructions [here for Python](https://doc.dataiku.com/dss/latest/python-api/outside-usage.html#using-the-dataiku-package), and [here for R](https://doc.dataiku.com/dss/latest/R-api/outside-usage.html#installing-the-dataiku-package)
- to have a Python or R extension to run easily the file (make sure it uses the right interpretor, with the dataiku package). For instance the [Microsoft Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) allows you to select a Python interpretor, and run the open file (open command Palette and search for *Python: Run Python File in Terminal*)
#### Web Apps
Web apps can be listed, browsed and their files edited and saved into DSS.
#### Plugins
Plugins folders and files can be deleted directly from the hierarchy. Folders such as files can also be added.
## Requirements
- Access to DSS instance running version 6.0.0 or above
- a valid Personal API key
## Extension Settings
There are two mandatory settings:
- the DSS instance base url (http(s)://DSS_HOST:DSS_PORT)
- the Personal API key
They are two ways to set them:
- Through environment variables:
Before starting VSCode export the following environment variables:
- DKU_DSS_URL=http(s)://DSS_HOST:DSS_PORT/
- DKU_API_KEY="Your API key secret"
- Through the configuration file ~/.dataiku/config.json.
- You can either create it manually with the following content :
```json
{
"dss_instances": {
"default": {
"url": "http(s)://DSS_HOST:DSS_PORT/",
"api_key": "Your API key secret"
}
},
"default_instance": "default"
}
```
Note that, if you have set multiple instances the extension will always use the one set as `default_instance`.
- Or you can use the extension commands to create and edit the file for you. Search for **DSS API** or **DSS URL** in the command Palette to launch one of the commands.
If you want to execute Python or R recipes locally and your DSS instance has SSL enabled, the dataiku package will verify the certificate. In order for this to work, you may need to add the root authority that signed the DSS SSL certificate to your local trust store. Please refer to your OS or Python manual for instructions.
If this is not possible, you can also disable checking the SSL certificate:
- By editing the configuration file:
```json
{
"dss_instances": {
"default": {
"url": "http(s)://DSS_HOST:DSS_PORT/",
"api_key": "Your API key secret",
"no_check_certificate": true
}
},
"default_instance": "default"
}
```
- Or by running one of the commands, search for **DSS certificate** in the command Palette