DCOS CLI ======= DCOS CLI with modular subcommands.

Setup

1. Make sure you meet requirements for installing packages

2. Install the "wheel" project:

   pip install wheel

3. Install the tox project:

   pip install tox

4. Clone git repo for the dcos cli:

   git clone git@github.com:mesosphere/dcos-cli.git

5. Change directory to the repo directory:

   cd dcos-cli

6. Create a virtualenv for the dcos cli project:

   virtualenv --prompt='(dcos-cli) ' env

Configure Development Environment

1. Activate the virtualenv:

   source env/bin/activate

2. Install project in develop mode:

   pip install -e .

3. Export DCOS_PATH:

   export DCOS_PATH=<path-to-project>/env

4. Export DCOS_CONFIG:

   mkdir $DCOS_PATH/config
   touch $DCOS_PATH/config/Dcos.toml
   export DCOS_CONFIG=$DCOS_PATH/env/config/Dcos.toml

Running POC

1. List command help:

   dcos --help

2. Run subcommand:

   dcos config --help

Running Tests:

1. Run tests using tox:

   tox

2. Run tests using tox through docker:

   CHECKOUT=<path-to-repo> \
   export DOCKER_REPO=mesosphere/python-tox \
   export DOCKER_TAG=v1 \
   sudo docker run -it -v $CHECKOUT:/dcos-cli $DOCKER_REPO:$DOCKER_TAG tox -c /dcos-cli/tox.ini

Notes

Submodule writing notes gathered so far:

1. Because we are using python's pip to install packages it looks like we can't install packages that share the same python's package of other installed packages because they will conflict once deployed to virtualenv directory structure.
2. Currently we require that subcommands implement an info command. For example dcos-subcommand implements subcommand info.