Setting up your workflow environment

Prerequisites

You need to have the env repository up to date.

git clone git@github.com:Deepomatic/env.git

And add this export to your .bashrc or .zshrc file:

export DEEPOMATIC_CONFIG_DIR={PATH_TO_DEEPOMATIC_ENV_REPO}

Export the necessary environment variables

Typically stored at the root of your project in an untracked .env file, some environment variables need to be set. Don't forget to source this file before executing your workflow.

# VESTA API KEY
# You can find that api key on studio in the My Account page. It's your api key for the concerned organization.
export VESTA_API_KEY=
# VULCAIN API KEY
# You can find that api key on the admin of the vulcain api (api.deepomatic.com/admin/). It is the admin key of the organization user.
# You can also find it on the admin of studio (https://studio.deepomatic.com/admin/vestauser/vestaorganization/), in the field vulcain_api_key of the concerned organization.
export VULCAIN_API_KEY=
export ORGANIZATION_SLUG=

# DEPLOYMENT
# This will be used to use/test your deployment. Please use the same credentials as those shared to the client.
export SITE_ID_PROD=
export SITE_ID_STAG=
export CUSTOMER_API_KEY=

# API URLS
export VULCAIN_API_URL="https://api.deepomatic.com/"
export ENGAGE_API_URL="https://studio.deepomatic.com/"

Install the deepomatic-workflows library

Currently, it lives inside the deepomatic-workflows repository, so you should first clone it :

git clone git@github.com:Deepomatic/deepomatic-workflows.git

For now, this repository still contains the old version of the workflows, so you need to switch to the v2 branch :

git checkout v2

Then, inside your favorite virtualenv (a clean one in python 3.8.13 preferably), you can install the CLI :

pip3 install {PATH_TO_DEEPOMATIC_WORKFLOWS_REPO}

If the installation goes smoothly, you should have a new command named wf_client :

wf_client --help