Installing

We recommend installing lcp-compose as a package dependency to ensure that version conflicts do not arise between dev/test environments.

Simply add lcp-compose as a dependency to the project's requirements/dev.txt file. 

$ cat requirements/dev.txt
--index-url=https://devpi.points.com/root/points/+simple/
# ...
lcp-compose==0.3.5
# ...

$ pip install -r requirements/dev.txt

Alternatively, use pip to install lcp-compose.

pip install --index-url=https://devpi.points.com/root/points/+simple/ lcp-compose==0.3.5

If performing a system-wide installation, simply execute the above pip command outside any virtualenv.

Verifying

Once installed, the lcp-compose command should be available on your shell.

$ lcp-compose --version
lcp-compose 0.3.5

To see what commands and options are available for lcp-compose, use:

lcp-compose -h

To see what options are available for the subcommands, use:

lcp-compose -h <subcommand>

e.g.,

# lcp-compose -h up
Usage: lcp-compose [--core-opts] up [--options] [other tasks here ...]

Docstring:
Start the dockerized LCP stack

provide ``--verify`` flag to run sanity tests after the stack is up:

lcp-compose up --verify

Options:
-s, --verify

Alternative installation methods

It is possible to install directly from the git repo or use a locally checked out copy of lcp-compose. This is useful when developing and debugging problems with lcp-compose.

Note: If using the git approach, make sure that you have a valid SSH key with access to the lcp-compose repository.

# git repo
pip install git+ssh://git@github.com:Points/lcp-compose.git

# locally checked out
pip install -e /path/to/lcp-compose

For more information on hacking lcp-compose see contribution guide.

Tab Completion

TODO:

Next?