Setup

To set up the project, follow the instructions detailed below:

Create Local Environment

Create a Python virtual environment and activate it:

python3 -m venv local_env
source local_env/bin/activate

Install the Project

Install the project in editable mode:

pip3 install -e .

Setup Pre-commit Hooks

pre-commit install

Configure Environment Variables

Copy the .env.example file to a .env file:

cp .env.example .env

The .env file contains several environment variables which need to be set:

OPENAI_API_KEY=your_openai_api_key_here
GITHUB_API_KEY=your_github_api_key
CONVERSATION_DB_PATH="$PWD/conversation_db.sqlite3"
TASK_DB_PATH="$PWD/task_db.sqlite3"
TASKS_OUTPUT_PATH="$PWD/tasks"
REPOSITORY_NAME="emrgnt-cmplxty/Automata"
MAX_WORKERS=8

Replace the placeholders with your own values. The OPENAI_API_KEY and GITHUB_API_KEY should be your personal API keys for OpenAI and GitHub respectively.

Detect Operating System

if [[ "$OSTYPE" == "darwin"* ]]; then
   # Mac OSX
   sed -i '' "s|your_openai_api_key|$OPEN_API_KEY|" .env
   sed -i '' "s|your_github_api_key|$GITHUB_API_KEY|" .env
   sed -i '' "s|your_conversation_db_path|$CONVERSATION_DB_PATH|" .env
   sed -i '' "s|your_task_db_path|$TASK_DB_PATH|" .env
   sed -i '' "s|your_tasks_output_path|$TASKS_OUTPUT_PATH|" .env
   sed -i '' "s|your_repository_name|$REPOSITORY_NAME|" .env
else
   # Linux and others
   sed -i "s|your_openai_api_key|$OPEN_API_KEY|" .env
   sed -i "s|your_github_api_key|$GITHUB_API_KEY|" .env
   sed -i "s|your_conversation_db_path|$CONVERSATION_DB_PATH|" .env
   sed -i "s|your_task_db_path|$TASK_DB_PATH|" .env
   sed -i "s|your_tasks_output_path|$TASKS_OUTPUT_PATH|" .env
   sed -i "s|your_repository_name|$REPOSITORY_NAME|" .env
fi

Fetch Submodules

git submodule update --init --recursive

Install and Initialize Git LFS

You must install git-lfs if you have not done so already:

For Ubuntu, run the following:

sudo apt-get install git-lfs

For Mac, run the following:

brew install git-lfs

Then, initialize by running the following:

git lfs install
git lfs pull