DKCloudCommand¶

DKCloudCommand is the command line tool made for interacting with the DataKitchen Automation API. If you prefer to operate at the command line, rather than use the Automation UI, can do so with DKCloudCommand.

Note that DKCloudCommand can also be run inside a custom container.

Note

Review the Automation Key Concepts documentation to understand concepts like kitchens, recipes, variations, orders, and ingredients. The command line interface (CLI) articles cover these concepts in less detail and instead focus on using the commands to build and run recipes.
A new version of DKCloudCommand is released with every Automation release. Follow release announcements in the Automation Release Notes documentation.

Python requirements¶

DKCloudCommand requires Python version 3.8 or newer

DKCloudCommand is compatible with Ubuntu 20.04 (pre-installed with Python 3.8.1) and Ubuntu 22.04 (pre-installed with Python 3.10).

Use a virtual environment¶

DataKitchen strongly recommends that all users install DKCloudCommand within a virtual environment (VE).

Two options are conda and virtualenv. Details and suggestions on how to set up these VEs are given below.

Install conda¶

Install Miniconda on your local machine using the appropriate installer. Then, execute the series of commands below to set up a conda VE named DataKitchen. This VE is where you'll install DKCloudCommand.

# Create a conda virtual environment named DataKitchen that uses Python 3.7
~ $ conda create -n DataKitchen python=3.7

# Activate the newly-created conda virtual environment (Windows)
~ $ activate DataKitchen
(DataKitchen) ~ $

# Activate the newly-created conda virtual environment (macOS)
~ $ source activate DataKitchen
(DataKitchen) ~ $

# When finished using the conda virtual environment, deactivate it
(DataKitchen) ~ $ source deactivate
~ $

Install virtualenv¶

Execute the following series of commands to install virtualenv. Create a VE named DataKitchen. This VE is where you'll install DKCloudCommand.

# Install virtualenv
~ $ pip install virtualenv

# Create and enter a directory to house local virtual environments
~ $ mkdir virtualenvs
~ $ cd virtualenvs

# Create a virtual environment named DataKitchen that uses Python 3.7
~ $ virtualenv DataKitchen --python=python3.7

# Activate the newly-created DataKitchen virtual environment
~ $ source DataKitchen/bin/activate
(DataKitchen) ~ $

# When finished using the virtual environment, deactivate it
(DataKitchen) ~ $ deactivate
~ $

Install and configure DKCloudCommand¶

Follow the steps in the articles below to set up DKCloudCommand: