Installing Idem

To install Idem, follow the steps for your operating system.

Where to find Idem

Idem is a Python project hosted on pypi.org and is installable with the package installer for Python.

Python version requirements

Idem requires Python 3.7 or later.

Linux

To install Idem on Linux, follow these steps.

1. Ensure that all of your packages are up to date.

   For Debian based distributions such as Ubuntu:

   sudo apt-get update
   sudo apt-get upgrade -y
   

   For RedHat based distributions such as CentOS:

   sudo yum update -y
   

2. Install Python 3.7 or later. Include the package installer for Python (PIP).

   For Debian based distributions such as Ubuntu:

   sudo apt install -y python3-pip build-essential libssl-dev libffi-dev python-dev python3-venv
   

   For RedHat based distributions such as CentOS:

   sudo yum groupinstall -y development
   

3. (Optional) Create a virtual environment in which to run Idem.

   mkdir environments
   cd environments
   python3 -m venv my_idem_env
   source my_idem_env/bin/activate
   

4. To meet encryption requirements, upgrade to the latest PIP.

   python3 -m pip install --upgrade pip
   

5. Install the latest Idem version.

   pip3 install idem
   

   Alternatively, install a specific Idem version.

   pip3 install idem==19.0.0
   

6. Verify your Idem version.

   idem --version
   

Windows

To install Idem on Windows, follow these steps.

1. Download and open the Python for Windows installer.

2. Select the option to add Python to the Windows PATH environment variable.

   

3. Run the installer, and follow the prompts.

4. In Windows, open Advanced system settings, click Environment Variables, and verify that the Python and PIP executables are included in the PATH system variable.

5. Open the Windows command prompt as an Administrator.

6. To meet encryption requirements, upgrade to the latest PIP.

   python3 -m pip install --upgrade pip
   

7. Install Idem.

   pip3 install idem
   

8. Verify your Idem version.

   idem --version
   

MacOS

To install Idem on MacOS, follow these steps.

1. From a terminal window, install the Homebrew package manager.

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
   

2. Install Python 3.

   brew install python
   

   Homebrew installs PIP for you.

3. Add the Python directory to the PATH environment variable.

   export PATH="/usr/local/opt/python/libexec/bin:$PATH"
   

4. (Optional) Create a virtual environment in which to run Idem.

   mkdir environments
   cd environments
   python3 -m venv my_idem_env
   source my_idem_env/bin/activate
   

5. To meet encryption requirements, upgrade to the latest PIP.

   python3 -m pip install --upgrade pip
   

6. Install the latest Idem version.

   pip3 install idem
   

   Alternatively, install a specific Idem version.

   pip3 install idem==19.0.0
   

7. Verify your Idem version.

   idem --version
   

What to do next

Tell Idem what infrastructure to manage. See Connecting Idem to providers.