Installation

Prerequisites

You’ll need an installation of Python on your computer. It needs to be version 3.7.1 or higher.

To fully utilize this tool, the following commands also need to be installed and available on your PATH:

evergreen: The evergreen command line tool.
git: Version 2.17 or higher
gh: The github command line tool.
pipx: Install python tools in isolated environments.

Evergreen authentication

Be sure to setup your .evergreen.yml configuration for authentication to evergreen. Details on ensure the evergreen cli is setup correctly can be found here.

Github authentication

Configure authentication to github with by running:

gh auth login

You can confirm authentication is configured corrected by running:

gh auth status

You should see output similar to the following:

github.com
  ✓ Logged in to github.com as username (/Users/username/.config/gh/hosts.yml)
  ✓ Git operations for github.com configured to use ssh protocol.
  ✓ Token: *******************

Installing evg-module-manager

Use pipx to install the tool:

pipx install evg-module-manager

Debugging installation issues

A common issue that arises during installation is pipx failing to install emm and printing out the following error:

$ pipx install evg-module-manager
Fatal error from pip prevented installation. Full pip output in file:
    /home/ubuntu/.local/pipx/logs/cmd_2022-03-31_13.24.42_pip_errors.log
 
Some possibly relevant errors from pip install:
    ERROR: Could not find a version that satisfies the requirement evg-module-manager (from versions: none)
    ERROR: No matching distribution found for evg-module-manager
 
Error installing evg-module-manager.

This error indicates that pipx could not find a version of emm that was built to support the version of Python installed on your machine. Make sure to check that your version of Python matches the requirements called out in the Prerequisites section. You can check the version of Python that is on your computer by running

$ python --version

If you are running into the issue above but are sure that the correct version of Python is installed on your computer, you can explicitly specify a path to the correct Python version during installation.

$ which python3.9
/usr/bin/python3.9
$ pipx install evg-module-manager --python /usr/bin/python3.9

Updating evg-module-manager

You can also use pipx to update to the latest version:

pipx upgrade evg-module-manager