# Setting up your workflow environment

## Prerequisites

You need to have the env repository up to date. 

```bash
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.

```bash
# 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 :

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

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

```shell
pip install -e ".[ci]"
```

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

```shell
wf_client --help
```