Installation ¶

Stable release ¶

Using docker ¶

docker run --rm -v ~/.aws:/root/.aws public.ecr.aws/compose-x/compose-x:latest

Hint

Head to https://gallery.ecr.aws/compose-x/compose-x to select a particular version if need be.

From Pip ¶

Warning

You must use pip>=21 to have all functionalities work. Simply run

             pip install pip -U

            

To install ECS-Compose-X, run this command in your terminal:

pip install --user ecs_composex

Hint

Highly recommend to create a new python virtualenv in order not to spread on all your machine

             python -m venv venv
source venv/bin/activate
pip install pip -U
pip install ecs_composex

            

This is the preferred method to install ECS-Compose-X, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guides you through the process.

From sources ¶

The sources for ECS-Compose-X can be downloaded from the Github repo .

You can either clone the public repository:

           $ git clone git://github.com/compose-x/ecs_composex

          

Or download the tarball :

           $ curl -OJL https://github.com/compose-x/ecs_composex/tarball/main

          

Once you have a copy of the source, you can install it

Using pip ¶

            # After git clone
cd ecs_composex
python -m venv venv
source venv/bin/activate
pip install pip -U
pip install .

           

Using poetry (recommended for development purposes) ¶

            # After git clone
cd ecs_composex
python -m venv venv
source venv/bin/activate
pip install pip -U
pip install poetry
poetry install

           

Hint

Using poetry will also install all the dev dependencies for local dev.