User_Using the CodaLab CLI Windows

William French edited this page Jun 17, 2014 · 3 revisions

Install and run the CLI tool on Windows

These instructions show you how to set up the bundle service and run the CodaLab CLI tool on Windows.

Install the prerequisites

Note: If you have already taken the steps outlined in Getting Started on Windows, the only prerequsite you need is SQL Alchemy.

  1. Install Python 2.7. Be sure to select the appropriate installer for your architecture. This typically will install to C:\Python27. The rest of these instructions will assume that you have installed to this path.

  2. To Install pip you should first install distribute. Download the file at the following URL: and run it from a shell from the directory into which it was downloaded:


    This will put easy_install.exe in the Scripts directory of your Python installation. Then, you're ready to install pip from a command prompt:

    C:\Python27\Scripts\easy_install.exe pip
  3. Next install virtualenv

    cd C:\Python27\Scripts
    pip install virtualenv
  4. Activate virtual env:

    virtualenv codalab_env
  5. Use the following command to install MySql-Python.

    easy_install mysql-python

  6. Install SQL Alchemy:

    pip install sqlalchemy

Get the source code

  1. Install the CodaLab CLI.

    pip install codalab-cli

Local Bundle Server Testing

These are some rough notes since the process is kind of disjointed.

Launching scripts

  1. Make sure you have this: C:\Users\v-wfren\Documents\GitHub\codalab-cli\codalab\bin\cl.bat

    @echo off
    set CODALAB="C:\Users\v-wfren\Documents\GitHub\codalab-cli"
    python %CODALAB%\codalab\bin\ %CODALAB%\codalab\config\mysql_client_config.json "%*"
  2. Create a PowerShell alias:

    Set-Alias -Name cl -Value "C:\Users\v-wfren\Documents\GitHub\codalab-cli\codalab\bin\cl.bat" -Description "Launch CodaLab CLI"

    Environment variables

    Note: I added these commands to my virtual environment powershell helper script.

  3. Set PYTHONPATH environment variable: [Environment]::SetEnvironmentVariable("PYTHONPATH", "C:\Users\v-wfren\Documents\GitHub\codalab-cli")

  4. Set PYTHON_EGG_CACHE environment variable: [Environment]::SetEnvironmentVariable("PYTHON_EGG_CACHE", "C:\PEC")

Configuration files

  1. Add this to C:\Users\v-wfren\Documents\GitHub\codalab\codalab\codalab\settings\
# Add these to the top.
from pkgutil import extend_path
import codalab

    # This is already there, just update the URL.
    BUNDLE_SERVICE_URL = "http://localhost:2800"

    BUNDLE_SERVICE_CODE_PATH = "..\\..\\..\\..\\codalab-cli" # path to codalab-cli relative to this file
        sys.path.append(join(dirname(abspath(__file__)), BUNDLE_SERVICE_CODE_PATH))
        codalab.__path__ = extend_path(codalab.__path__, codalab.__name__)
  1. Create codalab-cli\codalab\bin\bundle_server_config.json and add the following JSON:
  "home": "~/.codalab",
  "client": {
    "class": "LocalBundleClient"
  "model": {
    "class": "MySQLModel",
    "username": "user",
    "password": "password123",
    "address": "localhost",
    "database": "MySQL_DevDB"
  "server": {
    "address": ["localhost", 2800]
  1. Activate the codalab_env virtual environment.
  2. Start the local bundle service:

    python bundle_server_config.json


  • If you get an error message when accessing (access denied), make sure the bundle service is running.

  • Mod for CLI tool on Windows: C:\Users\v-wfren\Documents\GitHub\codalab-cli\codalab\lib\, line 80:

    data_size = int(path_util.get_size(temp_path, dirs_and_files))

I just added the int function here, it seems to work now.