add scripts

+<#
+.Synopsis
+Activate a Python virtual environment for the current PowerShell session.
+
+.Description
+Pushes the python executable for a virtual environment to the front of the
+$Env:PATH environment variable and sets the prompt to signify that you are
+in a Python virtual environment. Makes use of the command line switches as
+well as the `pyvenv.cfg` file values present in the virtual environment.
+
+.Parameter VenvDir
+Path to the directory that contains the virtual environment to activate. The
+default value for this is the parent of the directory that the Activate.ps1
+script is located within.
+
+.Parameter Prompt
+The prompt prefix to display when this virtual environment is activated. By
+default, this prompt is the name of the virtual environment folder (VenvDir)
+surrounded by parentheses and followed by a single space (ie. '(.venv) ').
+
+.Example
+Activate.ps1
+Activates the Python virtual environment that contains the Activate.ps1 script.
+
+.Example
+Activate.ps1 -Verbose
+Activates the Python virtual environment that contains the Activate.ps1 script,
+and shows extra information about the activation as it executes.
+
+.Example
+Activate.ps1 -VenvDir C:\Users\MyUser\Common\.venv
+Activates the Python virtual environment located in the specified location.
+
+.Example
+Activate.ps1 -Prompt "MyPython"
+Activates the Python virtual environment that contains the Activate.ps1 script,
+and prefixes the current prompt with the specified string (surrounded in
+parentheses) while the virtual environment is active.
+
+.Notes
+On Windows, it may be required to enable this Activate.ps1 script by setting the
+execution policy for the user. You can do this by issuing the following PowerShell
+command:
+
+PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+
+For more information on Execution Policies: 
+https://go.microsoft.com/fwlink/?LinkID=135170
+
+#>
+Param(
+    [Parameter(Mandatory = $false)]
+    [String]
+    $VenvDir,
+    [Parameter(Mandatory = $false)]
+    [String]
+    $Prompt
+)
+
+<# Function declarations --------------------------------------------------- #>
+
+<#
+.Synopsis
+Remove all shell session elements added by the Activate script, including the
+addition of the virtual environment's Python executable from the beginning of
+the PATH variable.
+
+.Parameter NonDestructive
+If present, do not remove this function from the global namespace for the
+session.
+
+#>
+function global:deactivate ([switch]$NonDestructive) {
+    # Revert to original values
+
+    # The prior prompt:
+    if (Test-Path -Path Function:_OLD_VIRTUAL_PROMPT) {
+        Copy-Item -Path Function:_OLD_VIRTUAL_PROMPT -Destination Function:prompt
+        Remove-Item -Path Function:_OLD_VIRTUAL_PROMPT
+    }
+
+    # The prior PYTHONHOME:
+    if (Test-Path -Path Env:_OLD_VIRTUAL_PYTHONHOME) {
+        Copy-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME -Destination Env:PYTHONHOME
+        Remove-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME
+    }
+
+    # The prior PATH:
+    if (Test-Path -Path Env:_OLD_VIRTUAL_PATH) {
+        Copy-Item -Path Env:_OLD_VIRTUAL_PATH -Destination Env:PATH
+        Remove-Item -Path Env:_OLD_VIRTUAL_PATH
+    }
+
+    # Just remove the VIRTUAL_ENV altogether:
+    if (Test-Path -Path Env:VIRTUAL_ENV) {
+        Remove-Item -Path env:VIRTUAL_ENV
+    }
+
+    # Just remove the _PYTHON_VENV_PROMPT_PREFIX altogether:
+    if (Get-Variable -Name "_PYTHON_VENV_PROMPT_PREFIX" -ErrorAction SilentlyContinue) {
+        Remove-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Scope Global -Force
+    }
+
+    # Leave deactivate function in the global namespace if requested:
+    if (-not $NonDestructive) {
+        Remove-Item -Path function:deactivate
+    }
+}
+
+<#
+.Description
+Get-PyVenvConfig parses the values from the pyvenv.cfg file located in the
+given folder, and returns them in a map.
+
+For each line in the pyvenv.cfg file, if that line can be parsed into exactly
+two strings separated by `=` (with any amount of whitespace surrounding the =)
+then it is considered a `key = value` line. The left hand string is the key,
+the right hand is the value.
+
+If the value starts with a `'` or a `"` then the first and last character is
+stripped from the value before being captured.
+
+.Parameter ConfigDir
+Path to the directory that contains the `pyvenv.cfg` file.
+#>
+function Get-PyVenvConfig(
+    [String]
+    $ConfigDir
+) {
+    Write-Verbose "Given ConfigDir=$ConfigDir, obtain values in pyvenv.cfg"
+
+    # Ensure the file exists, and issue a warning if it doesn't (but still allow the function to continue).
+    $pyvenvConfigPath = Join-Path -Resolve -Path $ConfigDir -ChildPath 'pyvenv.cfg' -ErrorAction Continue
+
+    # An empty map will be returned if no config file is found.
+    $pyvenvConfig = @{ }
+
+    if ($pyvenvConfigPath) {
+
+        Write-Verbose "File exists, parse `key = value` lines"
+        $pyvenvConfigContent = Get-Content -Path $pyvenvConfigPath
+
+        $pyvenvConfigContent | ForEach-Object {
+            $keyval = $PSItem -split "\s*=\s*", 2
+            if ($keyval[0] -and $keyval[1]) {
+                $val = $keyval[1]
+
+                # Remove extraneous quotations around a string value.
+                if ("'""".Contains($val.Substring(0, 1))) {
+                    $val = $val.Substring(1, $val.Length - 2)
+                }
+
+                $pyvenvConfig[$keyval[0]] = $val
+                Write-Verbose "Adding Key: '$($keyval[0])'='$val'"
+            }
+        }
+    }
+    return $pyvenvConfig
+}
+
+
+<# Begin Activate script --------------------------------------------------- #>
+
+# Determine the containing directory of this script
+$VenvExecPath = Split-Path -Parent $MyInvocation.MyCommand.Definition
+$VenvExecDir = Get-Item -Path $VenvExecPath
+
+Write-Verbose "Activation script is located in path: '$VenvExecPath'"
+Write-Verbose "VenvExecDir Fullname: '$($VenvExecDir.FullName)"
+Write-Verbose "VenvExecDir Name: '$($VenvExecDir.Name)"
+
+# Set values required in priority: CmdLine, ConfigFile, Default
+# First, get the location of the virtual environment, it might not be
+# VenvExecDir if specified on the command line.
+if ($VenvDir) {
+    Write-Verbose "VenvDir given as parameter, using '$VenvDir' to determine values"
+}
+else {
+    Write-Verbose "VenvDir not given as a parameter, using parent directory name as VenvDir."
+    $VenvDir = $VenvExecDir.Parent.FullName.TrimEnd("\\/")
+    Write-Verbose "VenvDir=$VenvDir"
+}
+
+# Next, read the `pyvenv.cfg` file to determine any required value such
+# as `prompt`.
+$pyvenvCfg = Get-PyVenvConfig -ConfigDir $VenvDir
+
+# Next, set the prompt from the command line, or the config file, or
+# just use the name of the virtual environment folder.
+if ($Prompt) {
+    Write-Verbose "Prompt specified as argument, using '$Prompt'"
+}
+else {
+    Write-Verbose "Prompt not specified as argument to script, checking pyvenv.cfg value"
+    if ($pyvenvCfg -and $pyvenvCfg['prompt']) {
+        Write-Verbose "  Setting based on value in pyvenv.cfg='$($pyvenvCfg['prompt'])'"
+        $Prompt = $pyvenvCfg['prompt'];
+    }
+    else {
+        Write-Verbose "  Setting prompt based on parent's directory's name. (Is the directory name passed to venv module when creating the virutal environment)"
+        Write-Verbose "  Got leaf-name of $VenvDir='$(Split-Path -Path $venvDir -Leaf)'"
+        $Prompt = Split-Path -Path $venvDir -Leaf
+    }
+}
+
+Write-Verbose "Prompt = '$Prompt'"
+Write-Verbose "VenvDir='$VenvDir'"
+
+# Deactivate any currently active virtual environment, but leave the
+# deactivate function in place.
+deactivate -nondestructive
+
+# Now set the environment variable VIRTUAL_ENV, used by many tools to determine
+# that there is an activated venv.
+$env:VIRTUAL_ENV = $VenvDir
+
+if (-not $Env:VIRTUAL_ENV_DISABLE_PROMPT) {
+
+    Write-Verbose "Setting prompt to '$Prompt'"
+
+    # Set the prompt to include the env name
+    # Make sure _OLD_VIRTUAL_PROMPT is global
+    function global:_OLD_VIRTUAL_PROMPT { "" }
+    Copy-Item -Path function:prompt -Destination function:_OLD_VIRTUAL_PROMPT
+    New-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Description "Python virtual environment prompt prefix" -Scope Global -Option ReadOnly -Visibility Public -Value $Prompt
+
+    function global:prompt {
+        Write-Host -NoNewline -ForegroundColor Green "($_PYTHON_VENV_PROMPT_PREFIX) "
+        _OLD_VIRTUAL_PROMPT
+    }
+}
+
+# Clear PYTHONHOME
+if (Test-Path -Path Env:PYTHONHOME) {
+    Copy-Item -Path Env:PYTHONHOME -Destination Env:_OLD_VIRTUAL_PYTHONHOME
+    Remove-Item -Path Env:PYTHONHOME
+}
+
+# Add the venv to the PATH
+Copy-Item -Path Env:PATH -Destination Env:_OLD_VIRTUAL_PATH
+$Env:PATH = "$VenvExecDir$([System.IO.Path]::PathSeparator)$Env:PATH"

+# This file must be used with "source bin/activate" *from bash*
+# you cannot run it directly
+
+deactivate () {
+    # reset old environment variables
+    if [ -n "${_OLD_VIRTUAL_PATH:-}" ] ; then
+        PATH="${_OLD_VIRTUAL_PATH:-}"
+        export PATH
+        unset _OLD_VIRTUAL_PATH
+    fi
+    if [ -n "${_OLD_VIRTUAL_PYTHONHOME:-}" ] ; then
+        PYTHONHOME="${_OLD_VIRTUAL_PYTHONHOME:-}"
+        export PYTHONHOME
+        unset _OLD_VIRTUAL_PYTHONHOME
+    fi
+
+    # This should detect bash and zsh, which have a hash command that must
+    # be called to get it to forget past commands.  Without forgetting
+    # past commands the $PATH changes we made may not be respected
+    if [ -n "${BASH:-}" -o -n "${ZSH_VERSION:-}" ] ; then
+        hash -r
+    fi
+
+    if [ -n "${_OLD_VIRTUAL_PS1:-}" ] ; then
+        PS1="${_OLD_VIRTUAL_PS1:-}"
+        export PS1
+        unset _OLD_VIRTUAL_PS1
+    fi
+
+    unset VIRTUAL_ENV
+    if [ ! "${1:-}" = "nondestructive" ] ; then
+    # Self destruct!
+        unset -f deactivate
+    fi
+}
+
+# unset irrelevant variables
+deactivate nondestructive
+
+VIRTUAL_ENV="/home/ubuntu/dbocl_pip"
+export VIRTUAL_ENV
+
+_OLD_VIRTUAL_PATH="$PATH"
+PATH="$VIRTUAL_ENV/bin:$PATH"
+export PATH
+
+# unset PYTHONHOME if set
+# this will fail if PYTHONHOME is set to the empty string (which is bad anyway)
+# could use `if (set -u; : $PYTHONHOME) ;` in bash
+if [ -n "${PYTHONHOME:-}" ] ; then
+    _OLD_VIRTUAL_PYTHONHOME="${PYTHONHOME:-}"
+    unset PYTHONHOME
+fi
+
+if [ -z "${VIRTUAL_ENV_DISABLE_PROMPT:-}" ] ; then
+    _OLD_VIRTUAL_PS1="${PS1:-}"
+    if [ "x(dbocl_pip) " != x ] ; then
+	PS1="(dbocl_pip) ${PS1:-}"
+    else
+    if [ "`basename \"$VIRTUAL_ENV\"`" = "__" ] ; then
+        # special case for Aspen magic directories
+        # see https://aspen.io/
+        PS1="[`basename \`dirname \"$VIRTUAL_ENV\"\``] $PS1"
+    else
+        PS1="(`basename \"$VIRTUAL_ENV\"`)$PS1"
+    fi
+    fi
+    export PS1
+fi
+
+# This should detect bash and zsh, which have a hash command that must
+# be called to get it to forget past commands.  Without forgetting
+# past commands the $PATH changes we made may not be respected
+if [ -n "${BASH:-}" -o -n "${ZSH_VERSION:-}" ] ; then
+    hash -r
+fi

+# This file must be used with "source bin/activate.csh" *from csh*.
+# You cannot run it directly.
+# Created by Davide Di Blasi <davidedb@gmail.com>.
+# Ported to Python 3.3 venv by Andrew Svetlov <andrew.svetlov@gmail.com>
+
+alias deactivate 'test $?_OLD_VIRTUAL_PATH != 0 && setenv PATH "$_OLD_VIRTUAL_PATH" && unset _OLD_VIRTUAL_PATH; rehash; test $?_OLD_VIRTUAL_PROMPT != 0 && set prompt="$_OLD_VIRTUAL_PROMPT" && unset _OLD_VIRTUAL_PROMPT; unsetenv VIRTUAL_ENV; test "\!:*" != "nondestructive" && unalias deactivate'
+
+# Unset irrelevant variables.
+deactivate nondestructive
+
+setenv VIRTUAL_ENV "/home/ubuntu/dbocl_pip"
+
+set _OLD_VIRTUAL_PATH="$PATH"
+setenv PATH "$VIRTUAL_ENV/bin:$PATH"
+
+
+set _OLD_VIRTUAL_PROMPT="$prompt"
+
+if (! "$?VIRTUAL_ENV_DISABLE_PROMPT") then
+    if ("dbocl_pip" != "") then
+        set env_name = "dbocl_pip"
+    else
+        if (`basename "VIRTUAL_ENV"` == "__") then
+            # special case for Aspen magic directories
+            # see https://aspen.io/
+            set env_name = `basename \`dirname "$VIRTUAL_ENV"\``
+        else
+            set env_name = `basename "$VIRTUAL_ENV"`
+        endif
+    endif
+    set prompt = "[$env_name] $prompt"
+    unset env_name
+endif
+
+alias pydoc python -m pydoc
+
+rehash

+# This file must be used with ". bin/activate.fish" *from fish* (http://fishshell.org)
+# you cannot run it directly
+
+function deactivate  -d "Exit virtualenv and return to normal shell environment"
+    # reset old environment variables
+    if test -n "$_OLD_VIRTUAL_PATH"
+        set -gx PATH $_OLD_VIRTUAL_PATH
+        set -e _OLD_VIRTUAL_PATH
+    end
+    if test -n "$_OLD_VIRTUAL_PYTHONHOME"
+        set -gx PYTHONHOME $_OLD_VIRTUAL_PYTHONHOME
+        set -e _OLD_VIRTUAL_PYTHONHOME
+    end
+
+    if test -n "$_OLD_FISH_PROMPT_OVERRIDE"
+        functions -e fish_prompt
+        set -e _OLD_FISH_PROMPT_OVERRIDE
+        functions -c _old_fish_prompt fish_prompt
+        functions -e _old_fish_prompt
+    end
+
+    set -e VIRTUAL_ENV
+    if test "$argv[1]" != "nondestructive"
+        # Self destruct!
+        functions -e deactivate
+    end
+end
+
+# unset irrelevant variables
+deactivate nondestructive
+
+set -gx VIRTUAL_ENV "/home/ubuntu/dbocl_pip"
+
+set -gx _OLD_VIRTUAL_PATH $PATH
+set -gx PATH "$VIRTUAL_ENV/bin" $PATH
+
+# unset PYTHONHOME if set
+if set -q PYTHONHOME
+    set -gx _OLD_VIRTUAL_PYTHONHOME $PYTHONHOME
+    set -e PYTHONHOME
+end
+
+if test -z "$VIRTUAL_ENV_DISABLE_PROMPT"
+    # fish uses a function instead of an env var to generate the prompt.
+
+    # save the current fish_prompt function as the function _old_fish_prompt
+    functions -c fish_prompt _old_fish_prompt
+
+    # with the original prompt function renamed, we can override with our own.
+    function fish_prompt
+        # Save the return status of the last command
+        set -l old_status $status
+
+        # Prompt override?
+        if test -n "(dbocl_pip) "
+            printf "%s%s" "(dbocl_pip) " (set_color normal)
+        else
+            # ...Otherwise, prepend env
+            set -l _checkbase (basename "$VIRTUAL_ENV")
+            if test $_checkbase = "__"
+                # special case for Aspen magic directories
+                # see https://aspen.io/
+                printf "%s[%s]%s " (set_color -b blue white) (basename (dirname "$VIRTUAL_ENV")) (set_color normal)
+            else
+                printf "%s(%s)%s" (set_color -b blue white) (basename "$VIRTUAL_ENV") (set_color normal)
+            end
+        end
+
+        # Restore the return status of the previous command.
+        echo "exit $old_status" | .
+        _old_fish_prompt
+    end
+
+    set -gx _OLD_FISH_PROMPT_OVERRIDE "$VIRTUAL_ENV"
+end

+#!/home/ubuntu/dbocl_pip/bin/python3.8
+# -*- coding: utf-8 -*-
+import re
+import sys
+from setuptools.command.easy_install import main
+if __name__ == '__main__':
+    sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
+    sys.exit(main())

+#!/home/ubuntu/dbocl_pip/bin/python3.8
+# -*- coding: utf-8 -*-
+import re
+import sys
+from setuptools.command.easy_install import main
+if __name__ == '__main__':
+    sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
+    sys.exit(main())

+#!/home/ubuntu/dbocl_pip/bin/python3.8
+# -*- coding: utf-8 -*-
+import re
+import sys
+from pip._internal.cli.main import main
+if __name__ == '__main__':
+    sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
+    sys.exit(main())

+#!/home/ubuntu/dbocl_pip/bin/python3.8
+# -*- coding: utf-8 -*-
+import re
+import sys
+from pip._internal.cli.main import main
+if __name__ == '__main__':
+    sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
+    sys.exit(main())

+#!/home/ubuntu/dbocl_pip/bin/python3.8
+# -*- coding: utf-8 -*-
+import re
+import sys
+from pip._internal.cli.main import main
+if __name__ == '__main__':
+    sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
+    sys.exit(main())

+python3.8
\ No newline at end of file

+python3.8
\ No newline at end of file

+/usr/bin/python3.8
\ No newline at end of file

+Copyright 2021 Vincent Nambatac
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+from dbocl_pkg import cdep
\ No newline at end of file

+#!/usr/bin/env python
+#
+# AWS cloud deployment tool for autoscaled applications.
+# Usage:
+#   $ ./cdep.py -h
+#
+# Requires:
+#   boto3 >= 1.6.6
+#   interruptingcow = 0.8
+#   pytz
+#
+
+
+
+import boto3
+import socket
+import time
+import subprocess
+import re
+import os
+import json
+import logging
+import sys
+import glob
+import argparse
+import logging as log
+import pytz
+import itertools
+
+from shutil import copy
+from interruptingcow import timeout
+from datetime import datetime
+from botocore.exceptions import ClientError
+
+logger = logging.getLogger()
+logger.setLevel(logging.INFO)
+
+# define boto3 clients
+asg_client = boto3.client('autoscaling')
+
+
+CDEP_VERSION = '1.2.2'
+
+TMP_DIR = '/tmp'
+
+DEFAULT_REGION = 'us-west-2'
+DEFAULT_VER = '$Default'
+DEFAULT_ASG_WAIT = 300
+
+STATE_PENDING = 0
+
+ASG_MIN_MINSIZE = 2
+ASG_MIN_MAXSIZE = 3
+
+SSH_KEYWORD_HOST = 'TARGET_IP'
+SSH_KEYWORD_PORT = 'TARGET_PORT'
+SSH_KEYWORD_COMMENT = 'TARGET_COMMENT'
+
+
+class Cleanable(object):
+    """
+    An interface for classes that need to perform
+    some kind of cleanup process at the end of the script run.
+    """
+    def _get_removable_files(self):
+        """
+        Return a string or a list of strings (file pathnames).
+        """
+        return []
+
+    def _get_cleanup_funs(self):
+        """
+        Return a dict or a list of dicts with the following keys/values:
+        [
+            {
+                'fun': <function>,
+                'args': <list>,
+                'kwargs': <dict>,
+            }
+        ]
+        """
+        return []
+
+
+class Cleaner(object):
+    """
+    Just a class that gathers filename paths and deletes them.
+    And also executes functions, supposedly as part of cleanup.
+    """
+    def __init__(self):
+        self.files = []
+        self.funs = []
+
+
+    def mark(self, cleanable):
+        """
+        Tag all deletable files from a Cleanable object.
+        Also get the cleanup functions to be executed later.
+        """
+        if not isinstance(cleanable, Cleanable):
+            log.error(
+                'Cleaner.mark(cleanable): Argument is '
+                'not an instance of Cleanable class.'
+            )
+            raise RuntimeError('Arg not an instance of Cleanable')
+
+        v = cleanable._get_removable_files()
+        if isinstance(v, list):
+            self.files += v
+        elif isinstance(v, str):
+            self.files.append(v)
+
+        v = cleanable._get_cleanup_funs()
+        if isinstance(v, list):
+            self.funs += v
+        elif isinstance(v, dict):
+            self.funs.append(v)
+
+
+    def cleanup(self):
+        for f in self.files:
+            log.debug('(cleaner) Removing file %s', f)
+            try: os.remove(f)
+            except OSError: pass
+
+        for f in self.funs:
+            f['fun'](*f['args'], **f['kwargs'])
+
+
+class AppDeployer(Cleanable):
+    """
+    Enables custom deploy methods on nodes.
+    """
+    def __init__(self, **kwargs):
+        self.ident = None
+        self.app_project_dir = kwargs.get('app_project_dir', '.')
+        self.mark_file_path = kwargs.get(
+            'mark_file_path', TMP_DIR + '/cd-app-deployed'
+        )
+        log.debug(
+            '[%s] app_project_dir: %s',
+            self.__class__.__name__,
+            self.app_project_dir
+        )
+
+
+    def deploy(self, ident=None):
+        self.ident = ident
+
+        if self.ident:
+            log.debug(
+                '%s idempotent deploy with id: %s',
+                self.__class__.__name__, self.ident
+            )
+            mark_file = self.mark_file_path + '_' + self.ident
+
+            if os.path.isfile(mark_file):
+                log.debug('Deploy mark file found: %s', mark_file)
+                log.info(
+                    'Skipping deploy. Existing deploy mark found for %s',
+                    self.ident
+                )
+            else:
+                log.debug('%s deploying now', self.__class__.__name__)
+                if self._do_deploy():
+                    log.debug('Writing deploy mark file to: %s', mark_file)
+                    open(mark_file, 'w').close()
+        else:
+            log.debug('%s non-idempotent deploy', self.__class__.__name__)
+            self._do_deploy()
+
+
+    def _do_deploy(self):
+        """
+        Please override this implementation in the subclass.
+        Return True if successful.
+        """
+        return True
+
+
+    def _get_removable_files(self):
+        if self.ident:
+            return self.mark_file_path + '_' + self.ident
+        return []
+
+
+class TestDeployer(AppDeployer):
+    """
+    A test deployer that does nothing
+    """
+    def __init__(self, **kwargs):
+        self.ssh = kwargs.get('ssh')
+        self.target_hostname = kwargs.get('target_hostname', 'test_target')
+        super(TestDeployer, self).__init__(**kwargs)
+
+
+    def _do_deploy(self):
+        if subprocess.call(['ssh', self.target_hostname, 'uname -a']) != 0:
+            raise RuntimeError('Unable to uname -a')
+        return True
+
+
+class CapDeployer(AppDeployer):
+    """
+    Customize deploy as Capistrano for Ruby-on-Rails.
+    """
+    def __init__(self, **kwargs):
+        self.ssh = kwargs.get('ssh')
+        self.cap_env = kwargs.get('cap_env', 'production')
+        log.debug('[%s] env: %s', self.__class__.__name__, self.cap_env)
+
+        super(CapDeployer, self).__init__(**kwargs)
+
+
+    def _do_deploy(self):
+        with SSHAgentEnv([self.ssh.id_rsa_file_path]) as senv:
+            com = ['bundle', 'exec', 'cap', self.cap_env]
+
+            com_1 = com + ['linked_files:upload_files']
+            log.debug('Working dir: %s', self.app_project_dir)
+            log.debug('Executing command: %s', ' '.join(com_1))
+            if subprocess.call(com_1, cwd=self.app_project_dir, env=senv) != 0:
+                log.error(
+                    '%s non-zero return value on: %s',
+                    self.__class__.__name__, ' '.join(com_1)
+                )
+                raise RuntimeError('Unable to upload linked_files')
+
+            com_2 = com + ['deploy']
+            log.debug('Working dir: %s', self.app_project_dir)
+            log.debug('Executing command: %s', ' '.join(com_2))
+            if subprocess.call(com_2, cwd=self.app_project_dir, env=senv) != 0:
+                log.error(
+                    '%s non-zero return value on: %s',
+                    self.__class__.__name__, ' '.join(com_2)
+                )
+                raise RuntimeError('Unable to deploy')
+        return True
+
+
+class SSHAgentEnv(object):
+    """
+    Takes care of deleting and renewing the SSH agent process.
+    Use this when doing some SSH-agent-dependent RPC on a remote IP.
+    """
+    def __init__(self, keys):
+        self.keys = keys
+        self.environ = None
+
+
+    def __enter__(self):
+        self.environ = os.environ.copy()
+        subprocess.call(['pkill', 'ssh-agent'])
+
+        try:
+            stro = subprocess.check_output(['ssh-agent', '-s'])
+        except subprocess.CalledProcessError as e:
+            log.exception('Error occurred while doing command: ssh-agent -s')
+            raise RuntimeError(
+                'ssh-agent -s error: {0}: {1}'.format(e.returncode, e.output)
+            )
+
+        for name, val in re.findall(r'([A-Z_]+)=([^;]+);', stro):
+            self.environ[name] = val
+        for key in self.keys:
+            subprocess.call(['ssh-add', key], env=self.environ)
+
+        return self.environ
+
+
+    def __exit__(self, type, value, traceback):
+        subprocess.call(['ssh-agent', '-k'], env=self.environ)
+
+
+class SSHInfo(object):
+    """
+    Contains information about current SSH config setup.
+    Also contains methods for configuring/reconfiguring user SSH client
+    for use when new remote nodes are created.
+    """
+    def __init__(self, **kwargs):
+        config_dir = kwargs.get('config_dir', os.path.expanduser('~/.ssh'))
+        log.debug(
+            '[%s] config_dir: %s',
+            self.__class__.__name__, config_dir
+        )
+
+        # Some default SSH client values
+        self.port = kwargs.get('port', 22)
+        self.wait_timeout = kwargs.get('wait_timeout', 60)
+        self.wait_interval = kwargs.get('wait_interval', 5)
+        self.wait_gap = kwargs.get('wait_gap', 3)
+        log.debug(
+            '[%s] port: %i',
+            self.__class__.__name__, self.port
+        )
+        log.debug(
+            '[%s] wait_timeout: %i',
+            self.__class__.__name__, self.wait_timeout
+        )
+        log.debug(
+            '[%s] wait_interval: %i',
+            self.__class__.__name__, self.wait_interval
+        )
+        log.debug(
+            '[%s] wait_gap: %i',
+            self.__class__.__name__, self.wait_gap
+        )
+
+        # Client SSH files location
+        self.config_file_path = kwargs.get(
+            'config_file_path', config_dir + '/config'
+        )
+        self.config_template_file_path = kwargs.get(
+            'config_template_file_path', config_dir + '/config.template'
+        )
+        self.id_rsa_file_path = kwargs.get(
+            'id_rsa_file_path', config_dir + '/id_rsa'
+        )
+        self.known_hosts_file_path = kwargs.get(
+            'known_hosts_file_path', config_dir + '/known_hosts'
+        )
+        log.debug(
+            '[%s] config_file_path: %s',
+            self.__class__.__name__, self.config_file_path
+        )
+        log.debug(
+            '[%s] config_template_file_path: %s',
+            self.__class__.__name__, self.config_template_file_path
+        )
+        log.debug(
+            '[%s] id_rsa_file_path: %s',
+            self.__class__.__name__, self.id_rsa_file_path
+        )
+        log.debug(
+            '[%s] known_hosts_file_path: %s',
+            self.__class__.__name__, self.known_hosts_file_path
+        )
+
+        # Used for the SSH config template (def: ~/.ssh/config.template)
+        self.host_keyword = kwargs.get('host_keyword', SSH_KEYWORD_HOST)
+        self.port_keyword = kwargs.get('port_keyword', SSH_KEYWORD_PORT)
+        self.comment_keyword = kwargs.get('comment_keyword', SSH_KEYWORD_COMMENT)
+        log.debug(
+            '[%s] host_keyword: %s',
+            self.__class__.__name__, self.host_keyword
+        )
+        log.debug(
+            '[%s] port_keyword: %s',
+            self.__class__.__name__, self.port_keyword
+        )
+        log.debug(
+            '[%s] comment_keyword: %s',
+            self.__class__.__name__, self.comment_keyword
+        )
+
+
+    def wait_for_ssh(self, ip_address):
+        """
+        Wait for SSH port on IP address to be open and accessible.
+        """
+        try:
+            with timeout(self.wait_timeout, exception=SystemError):
+                while True:
+                    try:
+                        log.info('Trying SSH to %s', ip_address)
+                        s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+                        with timeout(self.wait_interval, exception=RuntimeError):
+                            s.connect((ip_address, self.port))
+                        break;
+                    except RuntimeError:
+                        log.debug(
+                            '(Socket timeout: %i second/s)',
+                            self.wait_interval
+                        )
+                        pass
+                    except socket.error as e:
+                        log.debug('(Socket error: %s)', e)
+                        pass
+                    finally:
+                        s.close()
+                    log.debug('Waiting for %i second/s', self.wait_gap)
+                    time.sleep(self.wait_gap)
+
+        except SystemError:
+            log.exception('SSH timeout error: %i second/s', self.wait_timeout)
+            raise
+
+
+    def generate_ssh_config(self, ip_address, comment='node deploy'):
+        """
+        Add public RSA keys of IP address to current known hosts.
+        Generate new .ssh/config file.
+        """
+        if os.path.exists(self.known_hosts_file_path):
+            log.debug(
+                'Removing %s from %s',
+                ip_address, self.known_hosts_file_path
+            )
+            subprocess.call([
+                'ssh-keygen', '-R', ip_address,
+                '-f', self.known_hosts_file_path
+            ])
+        with open(self.known_hosts_file_path, 'a') as f:
+            log.debug(
+                'Adding %s to %s',
+                ip_address, self.known_hosts_file_path
+            )
+            subprocess.call(['ssh-keyscan', '-H', ip_address], stdout=f)
+
+        log.debug(
+            'Edit %s to pipe. Replace "%s" with "%s".',
+            self.config_template_file_path,
+            self.comment_keyword, comment
+        )
+        sedcomment = subprocess.Popen(
+            [
+                'sed',
+                's/{0}/{1}/'.format(self.comment_keyword, comment),
+                self.config_template_file_path
+            ],
+            stdout=subprocess.PIPE
+        )
+        log.debug(
+            'Edit %s to pipe. Replace "%s" with "%s".',
+            self.config_template_file_path,
+            self.host_keyword, ip_address
+        )
+        sedhost = subprocess.Popen(
+            ['sed', 's/{0}/{1}/'.format(self.host_keyword, ip_address)],
+            stdin=sedcomment.stdout,
+            stdout=subprocess.PIPE
+        )
+        log.debug(
+            'Edit %s to %s. Replace "%s" with "%s".',
+            self.config_template_file_path,
+            self.config_file_path,
+            self.port_keyword, self.port
+        )
+        with open(self.config_file_path, 'w') as f:
+            subprocess.call(
+                ['sed', 's/{0}/{1}/'.format(self.port_keyword, self.port)],
+                stdin=sedhost.stdout,
+                stdout=f
+            )
+        log.debug('Waiting on OS sed pipes')
+        sedcomment.wait()
+        sedhost.wait()
+
+
+class AWSDefault(object):
+
+    def __init__(self, **kwargs):
+        self.ident = kwargs.get('Ident', '')
+        self.profile_name = kwargs.get('ProfileName', None)
+        self.region = kwargs.get('Region', DEFAULT_REGION)
+        log.debug(
+            '[%s] profile_name: %s',
+            self.__class__.__name__, self.profile_name
+        )
+        log.debug(
+            '[%s] region: %s',
+            self.__class__.__name__, self.region
+        )
+
+        self.sess = boto3.session.Session(
+            region_name=self.region, profile_name=self.profile_name
+        )
+        self.ec2 = self.sess.resource('ec2')
+        self.asg = self.sess.client('autoscaling')
+        self.ecc = self.sess.client('ec2')
+
+
+    def _suff_id(self, string):
+        """
+        Just suffix ident to a string if ident is not an empty string.
+        """
+        if len(self.ident) > 0:
+            return string + '_' + self.ident
+        else:
+            return string
+
+
+class AppNode(AWSDefault, Cleanable):
+    """
+    The application server node. Plus the AMI, snapshot,
+    and Launch Templates involved.
+    """
+    def __init__(self, **kwargs):
+        super(AppNode, self).__init__(**kwargs)
+        log.debug('Now using %s ident: %s',
+            self.__class__.__name__, self.ident
+        )
+        self.instance_id = None
+        self.ami_id = None
+        self.snapshot_id = None
+
+        # Mandatory args
+        self.subnet = kwargs.get('Subnet')
+        self.launch_template_id = kwargs.get('LaunchTemplateId')
+        log.debug(
+            '[%s] subnet: %s',
+            self.__class__.__name__, self.subnet
+        )
+        log.debug(
+            '[%s] launch_template_id: %s',
+            self.__class__.__name__, self.launch_template_id
+        )
+
+        # Optional args (with defaults)
+        self.launch_template_version = kwargs.get(
+            'LaunchTemplateVersion', DEFAULT_VER
+        )
+        self.ami_name = kwargs.get('AmiName', 'code_deploy')
+        self.ami_desc = kwargs.get(
+            'AmiDesc', 'Generated by cloud_deploy script'
+        )
+        self.ami_wait_timeout = kwargs.get('AmiWaitTimeout', 300)
+        self.ami_wait_interval = kwargs.get('AmiWaitInterval', 7)
+        log.debug(
+            '[%s] launch_template_version: %s',
+            self.__class__.__name__, self.launch_template_version
+        )
+        log.debug(
+            '[%s] ami_name: %s',
+            self.__class__.__name__, self.ami_name
+        )
+        log.debug(
+            '[%s] ami_desc: %s',
+            self.__class__.__name__, self.ami_desc
+        )
+        log.debug(
+            '[%s] ami_wait_timeout: %i',
+            self.__class__.__name__, self.ami_wait_timeout
+        )
+        log.debug(
+            '[%s] ami_wait_interval: %i',
+            self.__class__.__name__, self.ami_wait_interval
+        )
+
+        self.instance_id_file_path = kwargs.get(
+            'InstanceIdFilePath', 
+            self._suff_id(TMP_DIR + '/cd-instance-id')
+        )
+        self.ami_id_file_path = kwargs.get(
+            'AmiIdFilePath', 
+            self._suff_id(TMP_DIR + '/cd-ami-id')
+        )
+        self.target_lt_base_file_path = kwargs.get(
+            'TargetLTBaseFilePath',
+            self._suff_id(TMP_DIR + '/cd-target-lt')
+        )
+
+
+    def launch_ec2(self):
+        """
+        Launch an EC2 instance from the given Launch Template and
+        return once the instance is at "running" state.
+        If there's already an instance running, use that instead.
+
+        Populates self.instance_id.
+        """
+        try:
+            with open(self.instance_id_file_path) as f:
+                log.debug('EC2 id file found: %s', self.instance_id_file_path)
+                log.info('Existing EC2 found')
+                self.instance_id = f.read().strip()
+
+        except IOError:
+            try:
+                log.info('Launching new EC2 from template %s version %s',
+                    self.launch_template_id,
+                    self.launch_template_version
+                )
+                insts = self.ec2.create_instances(
+                    MaxCount=1, MinCount=1, SubnetId=self.subnet,
+                    LaunchTemplate={
+                        'LaunchTemplateId': self.launch_template_id,
+                        'Version': self.launch_template_version
+                    }
+                )
+                self.instance_id = insts[0].id
+                log.debug(
+                    'Writing EC2 id to file: %s',
+                    self.instance_id_file_path
+                )
+                with open(self.instance_id_file_path, 'w') as f:
+                    f.write(self.instance_id)
+
+            except ClientError:
+                log.exception('Error launching EC2')
+                raise
+
+        log.info('EC2 instance id: %s. Waiting to run.', self.instance_id)
+        self.ec2.Instance(self.instance_id).wait_until_running()
+
+
+    def generate_ami(self):
+        """
+        Create an AMI of self.instance_id, and tag both AMI and its snapshot.
+
+        Populates self.ami_id and self.snapshot_id.
+        """
+        self._create_image()
+        self._tag_ami_snaps()
+
+
+    def _create_image(self):
+        """
+        Create an AMI from deployed node.
+        return once the AMI has been fully built.
+        If there's already an existing AMI, use that instead.
+        """
+        if self.instance_id is None:
+            log.error('No EC2 instance_id found')
+            raise RuntimeError('No EC2 instance found')
+
+        try:
+            with open(self.ami_id_file_path) as f:
+                log.debug('AMI id file found: %s', self.ami_id_file_path)
+                log.info('Existing AMI found')
+                self.ami_id = f.read().strip()
+
+        except IOError:
+            try:
+                log.info('Creating AMI from instance %s', self.instance_id)
+                i = self.ec2.Instance(self.instance_id)
+                image = i.create_image(
+                    BlockDeviceMappings=[self._get_block_device_mapping()],
+                    Description=self.ami_desc,
+                    Name=self._suff_id(self.ami_name)
+                )
+
+                self.ami_id = image.id
+                log.debug('Writing AMI id to file: %s', self.ami_id_file_path)
+                with open(self.ami_id_file_path, 'w') as f:
+                    f.write(self.ami_id)
+
+            except ClientError:
+                log.exception('Error creating AMI')
+                raise
+
+        log.info('Image id: %s. Waiting to exist.', self.ami_id)
+        self.ec2.Image(self.ami_id).wait_until_exists()
+        try:
+            with timeout(self.ami_wait_timeout, exception=RuntimeError):
+                while True:
+                    log.info('Waiting for AMI to be available')
+                    ami_state = self.ec2.Image(self.ami_id).state
+                    if ami_state == 'available': break
+                    log.debug('AMI %s state: %s', self.ami_id, ami_state)
+                    log.debug('Waiting for %i second/s', self.ami_wait_interval)
+                    time.sleep(self.ami_wait_interval)
+        except RuntimeError:
+            log.exception(
+                'AMI completion timeout error: %i seconds/s',
+                self.ami_wait_timeout
+            )
+            raise
+
+        self.snapshot_id = (
+            self.ec2.Image(self.ami_id)
+            .block_device_mappings[0]['Ebs']['SnapshotId']
+        )
+        log.info('Obtained snapshot id: %s', self.snapshot_id)
+
+
+    def _get_block_device_mapping(self):
+        i = self.ec2.Instance(self.instance_id)
+        ebs = i.block_device_mappings[0]['Ebs']
+        vol = self.ec2.Volume(ebs['VolumeId'])
+
+        log.debug(
+            '(BDMap) DeviceName: %s',
+            i.block_device_mappings[0]['DeviceName']
+        )
+        log.debug(
+            '(BDMap) Ebs.DeleteOnTermination: %s',
+            ebs['DeleteOnTermination']
+        )
+        log.debug('(BDMap) Ebs.VolumeSize: %s', vol.size)
+        log.debug('(BDMap) Ebs.VolumeType: %s', vol.volume_type)
+
+        return {
+            'DeviceName': i.block_device_mappings[0]['DeviceName'],
+            'Ebs': {
+                'DeleteOnTermination': ebs['DeleteOnTermination'],
+                'VolumeSize': vol.size,
+                'VolumeType': vol.volume_type
+            }
+        }
+
+
+    def _tag_ami_snaps(self):
+        """
+        Tag both snapshot and AMI with Name tags.
+        """
+        name_val = self._suff_id(self.ami_name)
+        tags = [{
+            'Key': 'Name',
+            'Value': name_val
+        }]
+
+        log.debug('Tagging AMI with: Name => %s', name_val)
+        self.ec2.Image(self.ami_id).create_tags(Tags=tags)
+
+        log.debug('Tagging snapshot with: Name => %s', name_val)
+        self.ec2.Snapshot(self.snapshot_id).create_tags(Tags=tags)
+
+
+    def create_new_lt_version(
+        self, lt_id, lt_source_ver=DEFAULT_VER, lt_desc='deployed'
+    ):
+        """
+        Create a new version for the target 'deployed' launch template
+        basing off the given source version. The new version
+        will now contain the new AMI of the previously deployed EC2 server.
+
+        The new LT version will be made the $Default version.
+        """
+        new_ver = None
+        new_ver_file_path = self.target_lt_base_file_path + '_' + lt_id
+
+        try:
+            with open(new_ver_file_path) as f:
+                log.debug('Version marker file found: %s', new_ver_file_path)
+                log.info('New version already created for LT: %s', lt_id)
+                new_ver = int(f.read().strip())
+
+        except IOError:
+            log.debug(
+                'Inserting snapshot id %s into block device mapping',
+                self.snapshot_id
+            )
+            bdmap = self._get_block_device_mapping()
+            bdmap['Ebs']['SnapshotId'] = self.snapshot_id
+            if len(self.ident) > 0:
+                lt_desc += ' ' + self.ident
+
+            try:
+                log.info('Creating new version for LT: %s', lt_id)
+                res = self.ecc.create_launch_template_version(
+                    LaunchTemplateId=lt_id,
+                    SourceVersion=lt_source_ver,
+                    VersionDescription=lt_desc,
+                    LaunchTemplateData={
+                        'ImageId': self.ami_id,
+                        'BlockDeviceMappings': [bdmap]
+                    }
+                )
+
+                new_ver = res['LaunchTemplateVersion']['VersionNumber']
+                log.debug(
+                    'Writing new LT version to file: %s',
+                    new_ver_file_path
+                )
+                with open(new_ver_file_path, 'w') as f:
+                    f.write(str(new_ver))
+
+            except ClientError:
+                log.exception('Error creating new launch template version')
+                raise
+
+        log.info('New launch template version: %i', new_ver)
+
+        try:
+            log.info('Updating designated %s version', DEFAULT_VER)
+            res = self.ecc.modify_launch_template(
+                LaunchTemplateId=lt_id,
+                DefaultVersion=str(new_ver)
+            )
+
+            if new_ver != res['LaunchTemplate']['DefaultVersionNumber']:
+                raise RuntimeError('Client result mismatch')
+
+        except ClientError:
+            log.exception('Error modifying launch template')
+            raise
+
+
+    def get_ip_address(self, address_type='private'):
+        if self.instance_id:
+            i = self.ec2.Instance(self.instance_id)
+            if address_type == 'private':
+                return i.private_ip_address
+            if address_type == 'public':
+                return i.public_ip_address
+        return None
+
+
+    def _get_removable_files(self):
+        return [
+            self.instance_id_file_path,
+            self.ami_id_file_path,
+        ] + glob.glob(self.target_lt_base_file_path + '_*')
+
+
+    def _get_cleanup_funs(self):
+        return [
+            {
+                'fun': log.info,
+                'args': ['Terminating EC2 instance id: %s', self.instance_id],
+                'kwargs': {},
+            },
+            {
+                'fun': self.ec2.Instance(self.instance_id).terminate,
+                'args': [],
+                'kwargs': {},
+            },
+        ]
+
+
+class ASGroup(AWSDefault, Cleanable):
+    """
+    The AWS Autoscaling Group. This class contains the
+    methods to perform and automated rolling termination deploy.
+    """
+    def __init__(self, **kwargs):
+        super(ASGroup, self).__init__(**kwargs)
+        log.debug('Now using %s ident: %s',
+            self.__class__.__name__, self.ident
+        )
+
+        # Optional args (with defaults)
+        self.wait_interval = kwargs.get('WaitInterval', 5)
+        log.debug(
+            '[%s] wait_interval: %i',
+            self.__class__.__name__, self.wait_interval
+        )
+
+        self.props_file_path = kwargs.get(
+            'PropsFilePath',
+            self._suff_id(TMP_DIR + '/cd-asg-props')
+        )
+        self.ins_file_path = kwargs.get(
+            'InstancesFilePath', 
+            self._suff_id(TMP_DIR + '/cd-asg-instances')
+        )
+        self.mark_file_path = kwargs.get(
+            'MarkFilePath',
+            self._suff_id(TMP_DIR + '/cd-asg-deployed')
+        )
+
+
+    def get_asg(self, asg_name):
+        """
+        Get the details of an autoscaling group.
+        """
+        try:
+            log.debug('Describe ASG details for %s', asg_name)
+            res = self.asg.describe_auto_scaling_groups(
+                AutoScalingGroupNames=[asg_name]
+            )
+        except ClientError:
+            log.exception('Error describing ASG %s', asg_name)
+            raise
+        asgs = res['AutoScalingGroups']
+
+        if len(asgs) != 1:
+            log.error(
+                'Number of results found for ASG %s: %i',
+                asg_name, len(asgs)
+            )
+            raise RuntimeError('Either ASG not found or found too many')
+
+        return asgs[0]
+
+
+    def get_ips_by_asg(self, asg_name, address_type='private'):
+        """
+        Get the IP addresses of the instances currently under an ASG.
+        """
+        asg = self.get_asg(asg_name)
+        ips = []
+
+        for i in asg['Instances']:
+            ins = self.ec2.Instance(i['InstanceId'])
+            if address_type == 'private':
+                ips.append(ins.private_ip_address)
+            elif address_type == 'public':
+                ips.append(ins.public_ip_address)
+        return ips
+
+
+    def rolling_termination_deploy(self, asg_name):
+        """
+        Perform a rolling termination deploy for the ASG.
+        This process makes sure there is no downtime when
+        it comes to "InService" instances.
+        """
+        asg = self.get_asg(asg_name)
+
+        if asg['DesiredCapacity'] == 0:
+            log.info('ASG DesiredCapacity is 0. Rolling deploy not needed.')
+            return True
+
+        # Data-gathering
+        minsize, maxsize, dessize, grace_prd = self._get_original_props(asg)
+        defunct_ins = self._get_defunct_instances(asg)
+
+        # In case we are resuming from a previous
+        # interrupted operation
+        all_ins = [i['InstanceId'] for i in asg['Instances']]
+        waiting_ins = list(set(all_ins) - set(defunct_ins))
+        if len(waiting_ins) > 0:
+            log.info(
+                'Pending instances before deployment:\n    %s',
+                '\n    '.join(waiting_ins)
+            )
+            self._wait_for_instances(waiting_ins, grace_prd)
+
+        # Adjust ASG sizes if they are too low
+        if asg['MinSize'] < ASG_MIN_MINSIZE:
+            if asg['MaxSize'] < ASG_MIN_MAXSIZE:
+                self._increase_to_floor_size(asg_name, increase_max=True)
+            else:
+                self._increase_to_floor_size(asg_name)
+
+            log.info('ASG size adjusted. Waiting for autoscaling events.')
+            self._wait_for_instances(
+                self._get_pending_instances(asg_name, grace_prd),
+                grace_prd
+            )
+
+        # Actual rolling termination deployment.
+        # But instead of termination, the instances are simply detached.
+        mark_file = self.mark_file_path + '_' + asg_name
+        try:
+            with open(mark_file) as f:
+                log.debug('ASG deploy mark file found: %s', mark_file)
+                stamp = f.read().strip()
+                log.info(
+                    'Rolling deploy for ASG %s (%s) already completed on %s',
+                    asg_name, self.ident, stamp
+                )
+
+        except IOError:
+            for i in defunct_ins:
+                is_attached = False
+                is_detach_ok = False
+                log.info('Removing old instance %s', i)
+
+                try:
+                    log.debug('Lookup instance %s', i)
+                    res = self.asg.describe_auto_scaling_instances(
+                        InstanceIds=[i]
+                    )
+                    if len(res['AutoScalingInstances']) == 1:
+                        is_attached = True
+                except ClientError as e:
+                    log.warning('Error on instance %s lookup: %s', i, e)
+
+                if is_attached:
+                    try:
+                        log.debug('Detach instance %s', i)
+                        self.asg.detach_instances(
+                            AutoScalingGroupName=asg_name,
+                            InstanceIds=[i],
+                            ShouldDecrementDesiredCapacity=False
+                        )
+                        is_detach_ok = True
+                    except ClientError as e:
+                        log.warning('Error detaching instance %s: %s', i, e)
+
+                if is_detach_ok:
+                    log.info('Waiting for replacement')
+                    self._wait_for_instances(
+                        self._get_pending_instances(asg_name, grace_prd),
+                        grace_prd
+                    )
+
+            # Terminate all defunct instances at once
+            for i in defunct_ins:
+                try:
+                    log.debug('Terminate instance %s', i)
+                    self.ec2.Instance(i).terminate()
+                except ClientError as e:
+                    log.warning('Error terminating instance %s: %s', i, e)
+
+            # ASG deploy idempotency based on asg's name and deploy ident
+            stamp = datetime.now(pytz.utc).strftime('%Y-%b-%d %I:%M%p %Z')
+            log.info('%s - ASG %s rolling deploy done', stamp, asg_name)
+            log.debug('Marking ASG deploy as done: %s', mark_file)
+            with open(mark_file, 'w') as f:
+                f.write(stamp)
+
+        # Get penultimate state of ASG data
+        minsize_new = None
+        try:
+            log.debug('Describe ASG details for %s', asg_name)
+            res = self.asg.describe_auto_scaling_groups(
+                AutoScalingGroupNames=[asg_name]
+            )
+            minsize_new = res['AutoScalingGroups'][0]['MinSize']
+        except ClientError:
+            log.exception('Error describing ASG %s', asg_name)
+            raise
+
+        # Restore ASG sizes if they were modified
+        if minsize != minsize_new:
+            self._set_asg_size(asg_name, minsize, maxsize, dessize)
+
+
+    def _get_defunct_instances(self, asg):
+        """
+        Get all currently healthy instances under an ASG.
+        Presumably, they will be terminated later on as part
+        of the rolling deploy.
+
+        If instances have already been determined in this way
+        through a previous operation, do not do it again.
+        """
+        asg_name = asg['AutoScalingGroupName']
+        instances = asg['Instances']
+        ins_file = self.ins_file_path + '_' + asg_name
+
+        try:
+            with open(ins_file) as f:
+                log.debug('ASG instances file found: %s', ins_file)
+                log.info(
+                    'Defunct ASG instances already obtained: %s', asg_name
+                )
+                defunct_ins = [s.strip() for s in f.readlines()]
+
+        except IOError:
+            defunct_ins = []
+            for i in instances:
+                if ( i['HealthStatus'] == 'Healthy' and
+                     i['LifecycleState'] == 'InService' ):
+                    defunct_ins.append(i['InstanceId'])
+
+            log.debug('Writing defunct ids to file: %s', ins_file)
+            with open(ins_file, 'w') as f:
+                f.writelines([s + '\n' for s in defunct_ins])
+
+        if len(defunct_ins) > 0:
+            log.info(
+                'Instances marked for removal:\n    %s',
+                '\n    '.join(defunct_ins)
+            )
+
+        return defunct_ins
+
+
+    def _get_original_props(self, asg):
+        """
+        Obtain the original MinSize, MaxSize, and DesiredCapacity of ASG.
+        Also gets the ASG's HealthCheckGracePeriod.
+        """
+        asg_name = asg['AutoScalingGroupName']
+        props_file = self.props_file_path + '_' + asg_name
+
+        try:
+            with open(props_file) as f:
+                log.debug('ASG properties file found: %s', props_file)
+                log.info('ASG sizes already obtained: %s', asg_name)
+                for prop in f.readlines():
+                    x = prop.strip().split('=')
+                    if x[0] == 'MinSize': minsize = int(x[1])
+                    if x[0] == 'MaxSize': maxsize = int(x[1])
+                    if x[0] == 'DesiredCapacity': dessize = int(x[1])
+
+        except IOError:
+            minsize = asg['MinSize']
+            maxsize = asg['MaxSize']
+            dessize = asg['DesiredCapacity']
+
+            log.debug(
+                'Writing original ASG properties to file: %s', props_file
+            )
+            props = [
+                'MinSize={}'.format(minsize),
+                'MaxSize={}'.format(maxsize),
+                'DesiredCapacity={}'.format(dessize),
+            ]
+            with open(props_file, 'w') as f:
+                f.writelines([prop + '\n' for prop in props])
+
+        log.info(
+            'ASG %s original sizes:\n' +
+            '  MinSize: %i\n  MaxSize: %i\n  DesiredCapacity: %i',
+            asg_name, minsize, maxsize, dessize
+        )
+
+        grace_prd = DEFAULT_ASG_WAIT
+        if asg['HealthCheckGracePeriod'] > 0:
+            grace_prd = asg['HealthCheckGracePeriod']
+        log.info('Internal wait timeout: %i', grace_prd)
+
+        return minsize, maxsize, dessize, grace_prd
+
+
+    def _get_pending_instances(self, asg_name, timelimit):
+        """
+        Poll the ASG for any instances that are in a 'pending'
+        run state, indicating that they have just been created.
+
+        Return as soon as 1 or more pending instances are found in a poll.
+
+        Throw an exception if timeout is reached and no
+        pending instances are found.
+        """
+        iids = []
+        try:
+            with timeout(timelimit, exception=RuntimeError):
+                while len(iids) == 0:
+                    log.info('Polling for new ASG instances')
+                    try:
+                        log.debug('Describe ASG details for %s', asg_name)
+                        res = self.asg.describe_auto_scaling_groups(
+                            AutoScalingGroupNames=[asg_name]
+                        )
+
+                        for i in res['AutoScalingGroups'][0]['Instances']:
+                            ins = self.ec2.Instance(i['InstanceId'])
+                            if ins.state['Code'] == STATE_PENDING:
+                                iids.append(i['InstanceId'])
+
+                    except ClientError as e:
+                        log.warning('Error describing ASG %s: %s', asg_name, e)
+
+                    if len(iids) == 0:
+                        log.debug('Waiting %i second/s', self.wait_interval)
+                        time.sleep(self.wait_interval)
+
+        except RuntimeError:
+            log.exception(
+                '[%s] Timeout waiting for new instances: %i second/s',
+                self.__class__.__name__, timelimit
+            )
+            raise
+
+        return iids
+
+
+    def _wait_for_instances(self, iids, timelimit):
+        """
+        Wait for instances to be available and InService under an ASG.
+        Time out after a certain period of time.
+        """
+        for iid in iids:
+            log.info('Waiting for instance %s to be running', iid)
+            i = self.ec2.Instance(iid)
+            i.wait_until_running()
+
+        try:
+            with timeout(timelimit, exception=RuntimeError):
+                while len(iids) > 0:
+                    try:
+                        log.debug('Describe ASG instances')
+                        res = self.asg.describe_auto_scaling_instances(
+                            InstanceIds=iids
+                        )
+                        for i in res['AutoScalingInstances']:
+                            if ( i['HealthStatus'] == 'HEALTHY' and
+                                 i['LifecycleState'] == 'InService' ):
+                                iids.remove(i['InstanceId'])
+                            else:
+                                log.info(
+                                    'Waiting for instance %s to be InService',
+                                    i['InstanceId']
+                                )
+
+                    except ClientError as e:
+                        log.warning(
+                            'Error enumerating ASG instances: %s', e
+                        )
+
+                    if len(iids) > 0:
+                        log.debug('Waiting %i second/s', self.wait_interval)
+                        time.sleep(self.wait_interval)
+
+        except RuntimeError:
+            log.exception(
+                '[%s] Timeout waiting for instances: %i second/s',
+                self.__class__.__name__, timelimit
+            )
+            raise
+
+
+    def _increase_to_floor_size(self, asg_name, increase_max=False):
+        """
+        Increase the MinSize and MaxSize to minimum values for rolling deploy.
+        """
+        args = {
+            'AutoScalingGroupName': asg_name,
+            'MinSize': ASG_MIN_MINSIZE,
+        }
+        log.info(
+            'Temporarily increasing ASG %s MinSize to %i',
+            asg_name, ASG_MIN_MINSIZE
+        )
+        if increase_max:
+            args['MaxSize'] = ASG_MIN_MAXSIZE
+            log.info(
+                'Temporarily increasing ASG %s MaxSize to %i',
+                asg_name, ASG_MIN_MAXSIZE
+            )
+        try:
+            self.asg.update_auto_scaling_group(**args)
+        except ClientError:
+            log.exception('Error updating ASG settings')
+            raise
+
+
+    def _set_asg_size(self, asg_name, minsize, maxsize, dessize):
+        """
+        Just set ASG's MinSize and MaxSize.
+        """
+        log.info(
+            'Setting ASG %s MinSize (%i), MaxSize (%i), DesiredCapacity (%i)',
+            asg_name, minsize, maxsize, dessize
+        )
+        try:
+            self.asg.update_auto_scaling_group(
+                AutoScalingGroupName=asg_name,
+                MinSize=minsize,
+                MaxSize=maxsize,
+                DesiredCapacity=dessize
+            )
+        except ClientError:
+            log.exception('Error updating ASG settings')
+            raise
+
+
+    def _get_removable_files(self):
+        return glob.glob(self.props_file_path + '_*') \
+               + glob.glob(self.ins_file_path + '_*') \
+               + glob.glob(self.mark_file_path + '_*')
+
+
+def main():
+    pr = argparse.ArgumentParser(
+        description=get_desc(), formatter_class=argparse.RawTextHelpFormatter
+    )
+
+    ga = pr.add_argument_group('Actions')
+    ga.add_argument(
+        '-V', '--version', action='version',
+        version='Cloud deploy v{}'.format(CDEP_VERSION)
+    )
+    ga.add_argument(
+        '--full-deploy', action='store_true',
+        help='Execute app deployment process. This is the default action.'
+    )
+    ga.add_argument(
+        '--rolling-termination', action='store_true',
+        help='Skip app deploy. Execute only rolling termination on ASGs.'
+    )
+    ga.add_argument(
+        '--get-asg-ips', action='store_true',
+        help='Get current IP addresses by ASG and exit'
+    )
+
+    gm = pr.add_argument_group('Modifiers')
+    gm.add_argument(
+        '-i', '--ident', help='Deployment identifier'
+    )
+    gm.add_argument(
+        '-v', '--verbose', action='store_true', help='Increase verbosity'
+    )
+
+    awso = pr.add_argument_group('AWS options')
+    awso.add_argument(
+        '-s', '--aws-subnet',
+        help='VPC subnet id. Required for full deploy.'
+    )
+    awso.add_argument(
+        '-l', '--aws-launch-template',
+        help='Source LT id. Required for full deploy.'
+    )
+    awso.add_argument(
+        '-p', '--aws-profile', help='Local IAM credentials (None)'
+    )
+    awso.add_argument(
+        '-r', '--aws-region', help='(us-east-1)'
+    )
+    awso.add_argument(
+        '--aws-launch-template-ver',
+        type=int, help='Source LT version ($Default)'
+    )
+    awso.add_argument(
+        '-L', '--aws-target-launch-template', nargs='*',
+        help='Target LT ids (None)'
+    )
+    awso.add_argument(
+        '--aws-target-launch-template-ver',
+        type=int, help='Target LT base version ($Default)'
+    )
+    awso.add_argument(
+        '-Y', '--aws-target-launch-template-desc',
+        help='Target LT description (deployed)'
+    )
+    awso.add_argument(
+        '-a', '--aws-autoscaling-group',
+        nargs='*', help='Autoscaling group names (None)'
+    )
+    awso.add_argument(
+        '-A', '--aws-ami-name', help='Generated AMI name (code_deploy)'
+    )
+    awso.add_argument(
+        '-X', '--aws-ami-desc', help='Generated AMI description (<boilerplate>)'
+    )
+    awso.add_argument(
+        '--aws-ami-wait-timeout',
+        type=int, help='Timeout for waiting on AMI (300)'
+    )
+    awso.add_argument(
+        '--aws-ami-wait-interval', type=int, help='Interval between checks (7)'
+    )
+    awso.add_argument(
+        '--aws-asg-wait-interval', type=int, help='Interval between checks (5)'
+    )
+    awso.add_argument(
+        '--aws-mark-ec2-file',
+        help='Marker file ({}/cd-instance-id)'.format(TMP_DIR)
+    )
+    awso.add_argument(
+        '--aws-mark-ami-file',
+        help='Marker file ({}/cd-ami-id)'.format(TMP_DIR)
+    )
+    awso.add_argument(
+        '--aws-mark-lt-file',
+        help='Marker file ({}/cd-target-lt)'.format(TMP_DIR)
+    )
+    awso.add_argument(
+        '--aws-mark-props-file',
+        help='Marker file ({}/cd-asg-props)'.format(TMP_DIR)
+    )
+    awso.add_argument(
+        '--aws-mark-instances-file',
+        help='Marker file ({}/cd-asg-instances)'.format(TMP_DIR)
+    )
+    awso.add_argument(
+        '--aws-mark-rolling-file',
+        help='Marker file ({}/cd-asg-rolling)'.format(TMP_DIR)
+    )
+
+    appo = pr.add_argument_group('App deployment options')
+    appo.add_argument(
+        '-d', '--app-project-dir', help='Location of project code (<cwd>)'
+    )
+    appo.add_argument(
+        '-e', '--app-cap-env', help='Capistrano env (production)'
+    )
+    appo.add_argument(
+        '-H', '--app-halt-after',
+        action='store_true', help='Halt script after application deploy'
+    )
+    appo.add_argument(
+        '--app-mark-file',
+        help='Marker file ({}/cd-app-deployed)'.format(TMP_DIR)
+    )
+
+    ssho = pr.add_argument_group('SSH options')
+    ssho.add_argument(
+        '--ssh-public', action='store_true', help='Target is a public IP'
+    )
+    ssho.add_argument(
+        '--ssh-port', type=int, help='Target SSH port (22)'
+    )
+    ssho.add_argument(
+        '--ssh-wait-timeout',
+        type=int, help='Overall timeout for SSH connection (60)'
+    )
+    ssho.add_argument(
+        '--ssh-wait-interval', type=int, help='Timeout for each SSH attempt (5)'
+    )
+    ssho.add_argument(
+        '--ssh-wait-gap', type=int, help='Wait time between SSH attempts (3)'
+    )
+
+    sshco = pr.add_argument_group('SSH client config options')
+    sshco.add_argument(
+        '--ssh-config-dir', help='Client SSH dir (~/.ssh)'
+    )
+    sshco.add_argument(
+        '--ssh-config-file', help='(<config_dir>/config)'
+    )
+    sshco.add_argument(
+        '--ssh-config-template-file', help='(<config_dir>/config.template)'
+    )
+    sshco.add_argument(
+        '--ssh-id-rsa-file', help='(<config_dir>/id_rsa)'
+    )
+    sshco.add_argument(
+        '--ssh-known-hosts-file', help='(<config_dir>/known_hosts)'
+    )
+
+    sshto = pr.add_argument_group('SSH config template options')
+    sshto.add_argument(
+        '--ssh-host-keyword', help='Replaceable keyword for Host (TARGET_IP)'
+    )
+    sshto.add_argument(
+        '--ssh-port-keyword', help='Replaceable keyword for Port (TARGET_PORT)'
+    )
+    sshto.add_argument(
+        '--ssh-comment-keyword',
+        help='Replaceable keyword as comments (TARGET_COMMENT)'
+    )
+
+    ar = pr.parse_args()
+
+    # Output verbosity settings
+    loglevel = log.INFO
+    if ar.verbose:
+        loglevel = log.DEBUG
+    log.basicConfig(
+        datefmt='%y-%m-%d %H:%M:%S',
+        format='%(asctime)s %(levelname)s:%(message)s',
+        level=loglevel,
+    )
+
+    cleaner = Cleaner()
+
+    # Target autoscaling groups
+    target_asgs = []
+    if ar.aws_autoscaling_group:
+        target_asgs = ar.aws_autoscaling_group
+
+    # AWS settings for ASGroup
+    asg_opts = options_asgroup(ar)
+    asgroup = ASGroup(**asg_opts)
+
+    # IP address type (relative to VPC)
+    add_type = 'private'
+    if ar.ssh_public:
+        add_type = 'public'
+
+    is_default_action = (not any([
+        ar.rolling_termination,
+        ar.get_asg_ips
+    ])) or ar.full_deploy
+
+    ### Action (default): Rolling Application Deploy ###
+
+    if is_default_action:
+        if not all([ar.aws_subnet, ar.aws_launch_template]):
+            pr.error('Missing argument/s: aws-subnet, aws-launch-template')
+
+        # SSH client settings
+        si_opts = options_sshinfo(ar)
+        ssh_info = SSHInfo(**si_opts)
+
+        # Capistrano application deployer settings
+        #ad_opts = options_capdeployer(ar)
+        #ad_opts['ssh'] = ssh_info
+        #cap = CapDeployer(**ad_opts)
+
+        # Test deployer
+        topts = {}
+        topts['ssh'] = ssh_info
+        td = TestDeployer(**topts)
+
+        # AWS settings for AppNode
+        aws_opts = options_appnode(ar)
+        aws_opts['Subnet'] = ar.aws_subnet
+        aws_opts['LaunchTemplateId'] = ar.aws_launch_template
+        node = AppNode(**aws_opts)
+
+        ident = 'none'
+        if ar.ident:
+            ident = ar.ident
+        log.info('Now using deploy identifier: %s', ident)
+
+        # Begin creating a new target EC2 node
+        node.launch_ec2()
+        log.info('New EC2 instance launched from Launch Template')
+
+        # Wait for the new EC2 server, then begin
+        # deploying the application (with Capistrano)
+        node_ip = node.get_ip_address(address_type=add_type)
+        if node_ip:
+            ssh_info.wait_for_ssh(node_ip)
+            ssh_info.generate_ssh_config(
+                node_ip, comment='Deployment Tag: {}'.format(ident)
+            )
+
+            deploy_ident = ident + '_ip' + node_ip
+            #cap.deploy(deploy_ident)
+            td.deploy(deploy_ident)
+            log.info('Application deployed to EC2 instance')
+
+        # If directed, stop the script
+        if ar.app_halt_after: non_graceful_halt()
+
+        # Begin creating a new AMI out of the EC2 node
+        node.generate_ami()
+        log.info('AMI generated from EC2 instance')
+
+        # Calculate target launch templates
+        target_lts = []
+        arg_lt_desc = ar.aws_target_launch_template_desc
+
+        if ar.aws_target_launch_template:
+            # If target LTs are provided, modify LTs.
+            # Deploy may proceed depending on ASGs provided.
+            for lt in ar.aws_target_launch_template:
+                x = { 'lt_id': lt }
+                if ar.aws_target_launch_template_ver:
+                    x['lt_source_ver'] = ar.aws_target_launch_template_ver
+                if arg_lt_desc:
+                    x['lt_desc'] = arg_lt_desc
+                target_lts.append(x)
+
+        else:
+            # If NO target LTs are provided, infer LTs
+            # from ASGs if ASGs are provided.
+            for asg_name in target_asgs:
+                asg = asgroup.get_asg(asg_name)
+                if asg['LaunchTemplate']:
+                    xid = asg['LaunchTemplate']['LaunchTemplateId']
+                    xver = asg['LaunchTemplate']['Version']
+                    x = {
+                        'lt_id': xid,
+                        'lt_source_ver': xver,
+                    }
+                    if arg_lt_desc:
+                        x['lt_desc'] = arg_lt_desc
+                    log.info(
+                        'Obtained target LT %s ver %s from ASG %s',
+                        xid, xver, asg_name
+                    )
+                    target_lts.append(x)
+
+        # Create new versions of the Launch Templates.
+        # New versions will now use the generated AMI.
+        for lt_args in target_lts:
+            node.create_new_lt_version(**lt_args)
+            log.info('Target Launch Template modified to use new AMI')
+
+        if len(target_asgs) > 0:
+            log.info('Proceeding to termination deploy of autoscaling groups')
+
+        cleaner.mark(node)
+        #cleaner.mark(cap)
+        cleaner.mark(td)
+
+    ### Action: Autoscaling Groups rolling termination ###
+
+    if is_default_action or ar.rolling_termination:
+        for asg_name in target_asgs:
+            asgroup.rolling_termination_deploy(asg_name)
+            log.info('Rolling deploy done for %s', asg_name)
+
+    ### Action: Get IP addresses ###
+
+    if ar.get_asg_ips:
+        for asg_name in target_asgs:
+            print(('[{}]'.format(asg_name)))
+            for ip in asgroup.get_ips_by_asg(asg_name, address_type=add_type):
+                print(ip)
+
+    cleaner.mark(asgroup)
+    cleaner.cleanup()
+    sys.exit(0)
+
+
+def non_graceful_halt():
+    log.info(
+        '---------------\n'
+        'Script execution paused by user argument.'
+        'You may SSH into the deploy target instance and '
+        'perform commands, and/or continue the process later.'
+        '\n\nTo resume execution, simply repeat the deploy command '
+        'without the "-H" or "--app-halt-after" flag.\n'
+        '---------------'
+    )
+    sys.exit(0)
+
+
+def get_desc():
+    return (
+        'DESCRIPTION'
+
+        '\n\nPerform a rolling termination deployment on an AWS autoscaling '
+        'group. Works best under the following conditions:'
+
+        '\n\n- The autoscaling group (ASG) uses Launch Templates, instead of '
+        'Launch Configurations.'
+        '\n- The ASG uses the $Default version of its Launch Template.'
+        '\n- At the start of deploy, when a fresh EC2 is created, the script '
+        'will ask for a Launch Template, not an AMI directly.'
+
+        '\n\nPROCESS'
+
+        '\n\nGiven the source launch template ID, target launch template ID/s, '
+        'target autoscaling group name/s, and a Ruby on Rails app project '
+        'directory, this script will:'
+
+        '\n\n1) Create a temporary EC2 instance from source launch template.'
+        '\n2) Perform a Capistrano deploy on that instance. (Other app '
+        'deployment methods will be added in the future.)'
+        '\n3) Generate an AMI from that instance.'
+        '\n4) Create a new version of the target launch template/s which '
+        'now uses the new AMI ID obtained in (3).'
+        '\n5) Do a rolling termination on the existing instances of the '
+        'target autoscaling group/s, allowing them to be automatically '
+        'replaced by the ASG as they are being removed one by one.'
+        '\n6) Terminate the temporary instance created in (1).'
+
+        '\n\nCLIENT SSH CONFIG TEMPLATING'
+
+        '\n\nIn order to SSH to the new EC2 instance, this script utilizes '
+        'a template for the client SSH config (by default, it is located at '
+        '~/.ssh/config.template). This template contains a Host stub with '
+        'a designated keyword in place of an IP address. When the new EC2 '
+        'is created, the template is used to create a new client SSH config '
+        "file (~/.ssh/config), with the keyword replaced by the instance's "
+        "actual IP address. The project's Capistrano deploy configuration "
+        'should be made to reflect this setup.'
+
+        '\n\nEXAMPLE USAGE'
+
+        '\n\n$ ./cdep.py -s subnet-123abc -l lt-abc123xyz '
+        "-A myapp-ami -X 'Myapp server image' -Y 'Myapp LT' "
+        '-a mygroup-asg -d /home/john/myproj -i v1.0.0 -H'
+
+        '\n\nThe command above creates a new instance from launch template '
+        'lt-abc123xyz, then does a Capistrano production deploy to it. After '
+        'deployment, the script is halted so the user can SSH to the instance '
+        'and perform additional operations, if desired.'
+
+        '\n\nWhen ready, the command should be repeated without the -H flag. '
+        'If so, the deploy continues by creating an AMI from the finalized '
+        'instance. The target launch templates, inferred from the given '
+        'autoscaling group mygroup-asg, is updated to '
+        'use this new AMI. Finally, existing mygroup-asg instances are removed '
+        'one by one for auto-replacement to trigger with new instances.'
+
+        '\n\nFILES'
+
+        '\n\n/tmp/cd-*'
+        '\n~/.ssh/config.template'
+        '\n~/.ssh/config'
+    )
+
+
+def options_sshinfo(args):
+    x = {}
+    if args.ssh_port:
+        x['port'] = args.ssh_port
+    if args.ssh_wait_timeout:
+        x['wait_timeout'] = args.ssh_wait_timeout
+    if args.ssh_wait_interval:
+        x['wait_interval'] = args.ssh_wait_interval
+    if args.ssh_wait_gap:
+        x['wait_gap'] = args.ssh_wait_gap
+
+    if args.ssh_host_keyword:
+        x['host_keyword'] = args.ssh_host_keyword
+    if args.ssh_port_keyword:
+        x['port_keyword'] = args.ssh_port_keyword
+    if args.ssh_comment_keyword:
+        x['comment_keyword'] = args.ssh_comment_keyword
+
+    if args.ssh_config_dir:
+        x['config_dir'] = args.ssh_config_dir
+    if args.ssh_config_file:
+        x['config_file_path'] = args.ssh_config_file
+    if args.ssh_config_template_file:
+        x['config_template_file_path'] = args.ssh_config_template_file
+    if args.ssh_id_rsa_file:
+        x['id_rsa_file_path'] = args.ssh_id_rsa_file
+    if args.ssh_known_hosts_file:
+        x['known_hosts_file_path'] = args.ssh_known_hosts_file
+    return x
+
+
+def options_capdeployer(args):
+    x = {}
+    if args.app_project_dir:
+        x['app_project_dir'] = args.app_project_dir
+    if args.app_cap_env:
+        x['cap_env'] = args.app_cap_env
+    if args.app_mark_file:
+        x['mark_file_path'] = args.app_mark_file
+    return x
+
+
+def options_appnode(args):
+    x = {}
+    if args.ident:
+        x['Ident'] = args.ident
+    if args.aws_profile:
+        x['ProfileName'] = args.aws_profile
+    if args.aws_region:
+        x['Region'] = args.aws_region
+    if args.aws_launch_template_ver:
+        x['LaunchTemplateVersion'] = args.aws_launch_template_ver
+    if args.aws_ami_name:
+        x['AmiName'] = args.aws_ami_name
+    if args.aws_ami_desc:
+        x['AmiDesc'] = args.aws_ami_desc
+    if args.aws_ami_wait_timeout:
+        x['AmiWaitTimeout'] = args.aws_ami_wait_timeout
+    if args.aws_ami_wait_interval:
+        x['AmiWaitInterval'] = args.aws_ami_wait_interval
+    if args.aws_mark_ec2_file:
+        x['InstanceIdFilePath'] = args.aws_mark_ec2_file
+    if args.aws_mark_ami_file:
+        x['AmiIdFilePath'] = args.aws_mark_ami_file
+    if args.aws_mark_lt_file:
+        x['TargetLTBaseFilePath'] = args.aws_mark_lt_file
+    return x
+
+
+def options_asgroup(args):
+    x = {}
+    if args.ident:
+        x['Ident'] = args.ident
+    if args.aws_profile:
+        x['ProfileName'] = args.aws_profile
+    if args.aws_region:
+        x['Region'] = args.aws_region
+    if args.aws_ami_wait_interval:
+        x['WaitInterval'] = args.aws_ami_wait_interval
+    if args.aws_mark_props_file:
+        x['PropsFilePath'] = args.aws_mark_props_file
+    if args.aws_mark_instances_file:
+        x['InstancesFilePath'] = args.aws_mark_instances_file
+    if args.aws_mark_rolling_file:
+        x['MarkFilePath'] = args.aws_mark_rolling_file
+    return x
+
+
+if __name__ == '__main__':
+    main()

+[build-system]
+requires = [
+    "setuptools>=54"
+    "wheel"
+    "boto3>=1.6.6"
+    "interruptingcow"
+    "pytz"
+]
+
+build-backend = "setuptools.build_metadata"
\ No newline at end of file

+
+# Setting up
+[metadata]
+name = application-deployer
+version = 0.0.1
+author = leecher (ChromediaInc)
+author_email = vincent.nambatac@chromedia.com
+description = App deployer for aws environment
+long_description_content_type = text/markdown
+#    long_description=long_description,
+
+#    keywords=['python', 'video', 'stream', 'video stream', 'camera stream', 'sockets'],
+classifiers =
+    Development Status :: 1 - Staging
+    Intended Audience :: Developers
+    Programming Language :: Python :: 3
+    Operating System :: Unix
+    Operating System :: MacOS :: MacOS X
+    Operating System :: Microsoft :: Windows
+    License :: OSI Approved :: MIT License
+
+[options]
+packages = find:
+python_requires = >=3.7
+include_package_data = True
+
+    
+

+from setuptools import setup, find_packages
+import codecs
+import os
+
+
+VERSION = '0.0.1'
+DESCRIPTION = 'dbocl env deployment method'
+#LONG_DESCRIPTION = 'A package that allows to deploy application and build auto scaled instances and ami'
+
+# Setting up
+setup(
+    name="app-deployer",
+    version=VERSION,
+    author="leecher (ChromediaInc)",
+    author_email="info@chromedia.com",
+    description=DESCRIPTION,
+    long_description_content_type="text/markdown",
+#    long_description=long_description,
+    packages=find_packages(),
+    install_requires=['boto3', 'interruptingcow' , 'pytz', 'aws-cli'],
+#    keywords=['python', 'video', 'stream', 'video stream', 'camera stream', 'sockets'],
+    classifiers=[
+        "Development Status :: 1 - Planning",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python :: 3",
+        "Operating System :: Unix",
+        "Operating System :: MacOS :: MacOS X",
+        "Operating System :: Microsoft :: Windows",
+    ]
+)
+

+"""Run the EasyInstall command"""
+
+if __name__ == '__main__':
+    from setuptools.command.easy_install import main
+    main()

+pip

+Copyright (c) 2008-2019 The pip developers (see AUTHORS.txt file)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+Metadata-Version: 2.1
+Name: pip
+Version: 20.0.2
+Summary: The PyPA recommended tool for installing Python packages.
+Home-page: https://pip.pypa.io/
+Author: The pip developers
+Author-email: pypa-dev@groups.google.com
+License: MIT
+Project-URL: Documentation, https://pip.pypa.io
+Project-URL: Source, https://github.com/pypa/pip
+Keywords: distutils easy_install egg setuptools wheel virtualenv
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*
+
+pip - The Python Package Installer
+==================================
+
+.. image:: https://img.shields.io/pypi/v/pip.svg
+   :target: https://pypi.org/project/pip/
+
+.. image:: https://readthedocs.org/projects/pip/badge/?version=latest
+   :target: https://pip.pypa.io/en/latest
+
+pip is the `package installer`_ for Python. You can use pip to install packages from the `Python Package Index`_ and other indexes.
+
+Please take a look at our documentation for how to install and use pip:
+
+* `Installation`_
+* `Usage`_
+
+Updates are released regularly, with a new version every 3 months. More details can be found in our documentation:
+
+* `Release notes`_
+* `Release process`_
+
+If you find bugs, need help, or want to talk to the developers please use our mailing lists or chat rooms:
+
+* `Issue tracking`_
+* `Discourse channel`_
+* `User IRC`_
+
+If you want to get involved head over to GitHub to get the source code, look at our development documentation and feel free to jump on the developer mailing lists and chat rooms:
+
+* `GitHub page`_
+* `Dev documentation`_
+* `Dev mailing list`_
+* `Dev IRC`_
+
+Code of Conduct
+---------------
+
+Everyone interacting in the pip project's codebases, issue trackers, chat
+rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.
+
+.. _package installer: https://packaging.python.org/guides/tool-recommendations/
+.. _Python Package Index: https://pypi.org
+.. _Installation: https://pip.pypa.io/en/stable/installing.html
+.. _Usage: https://pip.pypa.io/en/stable/
+.. _Release notes: https://pip.pypa.io/en/stable/news.html
+.. _Release process: https://pip.pypa.io/en/latest/development/release-process/
+.. _GitHub page: https://github.com/pypa/pip
+.. _Dev documentation: https://pip.pypa.io/en/latest/development
+.. _Issue tracking: https://github.com/pypa/pip/issues
+.. _Discourse channel: https://discuss.python.org/c/packaging
+.. _Dev mailing list: https://groups.google.com/forum/#!forum/pypa-dev
+.. _User IRC: https://webchat.freenode.net/?channels=%23pypa
+.. _Dev IRC: https://webchat.freenode.net/?channels=%23pypa-dev
+.. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/
+
+

+../../../bin/pip,sha256=gpPWkLN6MR4Uh1-v9bSu9ZjnCcIy7Vgo8eo4Q2La7GM,241
+../../../bin/pip3,sha256=gpPWkLN6MR4Uh1-v9bSu9ZjnCcIy7Vgo8eo4Q2La7GM,241
+../../../bin/pip3.8,sha256=gpPWkLN6MR4Uh1-v9bSu9ZjnCcIy7Vgo8eo4Q2La7GM,241
+pip-20.0.2.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+pip-20.0.2.dist-info/LICENSE.txt,sha256=W6Ifuwlk-TatfRU2LR7W1JMcyMj5_y1NkRkOEJvnRDE,1090
+pip-20.0.2.dist-info/METADATA,sha256=MSgjT2JTt8usp4Hopp5AGEmc-7sKR2Jd7HTMJqCoRhw,3352
+pip-20.0.2.dist-info/RECORD,,
+pip-20.0.2.dist-info/WHEEL,sha256=kGT74LWyRUZrL4VgLh6_g12IeVl_9u9ZVhadrgXZUEY,110
+pip-20.0.2.dist-info/entry_points.txt,sha256=HtfDOwpUlr9s73jqLQ6wF9V0_0qvUXJwCBz7Vwx0Ue0,125
+pip-20.0.2.dist-info/top_level.txt,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+pip/__init__.py,sha256=U1AM82iShMaw90K6Yq0Q2-AZ1EsOcqQLQRB-rxwFtII,455
+pip/__main__.py,sha256=NM95x7KuQr-lwPoTjAC0d_QzLJsJjpmAoxZg0mP8s98,632
+pip/__pycache__/__init__.cpython-38.pyc,,
+pip/__pycache__/__main__.cpython-38.pyc,,
+pip/_internal/__init__.py,sha256=j5fiII6yCeZjpW7_7wAVRMM4DwE-gyARGVU4yAADDeE,517
+pip/_internal/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/__pycache__/build_env.cpython-38.pyc,,
+pip/_internal/__pycache__/cache.cpython-38.pyc,,
+pip/_internal/__pycache__/configuration.cpython-38.pyc,,
+pip/_internal/__pycache__/exceptions.cpython-38.pyc,,
+pip/_internal/__pycache__/legacy_resolve.cpython-38.pyc,,
+pip/_internal/__pycache__/locations.cpython-38.pyc,,
+pip/_internal/__pycache__/main.cpython-38.pyc,,
+pip/_internal/__pycache__/pep425tags.cpython-38.pyc,,
+pip/_internal/__pycache__/pyproject.cpython-38.pyc,,
+pip/_internal/__pycache__/self_outdated_check.cpython-38.pyc,,
+pip/_internal/__pycache__/wheel_builder.cpython-38.pyc,,
+pip/_internal/build_env.py,sha256=--aNgzIdYrCOclHMwoAdpclCpfdFE_jooRuCy5gczwg,7532
+pip/_internal/cache.py,sha256=16GrnDRLBQNlfKWIuIF6Sa-EFS78kez_w1WEjT3ykTI,11605
+pip/_internal/cli/__init__.py,sha256=FkHBgpxxb-_gd6r1FjnNhfMOzAUYyXoXKJ6abijfcFU,132
+pip/_internal/cli/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/cli/__pycache__/autocompletion.cpython-38.pyc,,
+pip/_internal/cli/__pycache__/base_command.cpython-38.pyc,,
+pip/_internal/cli/__pycache__/cmdoptions.cpython-38.pyc,,
+pip/_internal/cli/__pycache__/command_context.cpython-38.pyc,,
+pip/_internal/cli/__pycache__/main.cpython-38.pyc,,
+pip/_internal/cli/__pycache__/main_parser.cpython-38.pyc,,
+pip/_internal/cli/__pycache__/parser.cpython-38.pyc,,
+pip/_internal/cli/__pycache__/req_command.cpython-38.pyc,,
+pip/_internal/cli/__pycache__/status_codes.cpython-38.pyc,,
+pip/_internal/cli/autocompletion.py,sha256=ekGNtcDI0p7rFVc-7s4T9Tbss4Jgb7vsB649XJIblRg,6547
+pip/_internal/cli/base_command.py,sha256=v6yl5XNRqye8BT9ep8wvpMu6lylP_Hu6D95r_HqbpbQ,7948
+pip/_internal/cli/cmdoptions.py,sha256=f1TVHuu_fR3lLlMo6b367H_GsWFv26tLI9cAS-kZfE0,28114
+pip/_internal/cli/command_context.py,sha256=ygMVoTy2jpNilKT-6416gFSQpaBtrKRBbVbi2fy__EU,975
+pip/_internal/cli/main.py,sha256=8iq3bHe5lxJTB2EvKOqZ38NS0MmoS79_S1kgj4QuH8A,2610
+pip/_internal/cli/main_parser.py,sha256=W9OWeryh7ZkqELohaFh0Ko9sB98ZkSeDmnYbOZ1imBc,2819
+pip/_internal/cli/parser.py,sha256=O9djTuYQuSfObiY-NU6p4MJCfWsRUnDpE2YGA_fwols,9487
+pip/_internal/cli/req_command.py,sha256=pAUAglpTn0mUA6lRs7KN71yOm1KDabD0ySVTQTqWTSA,12463
+pip/_internal/cli/status_codes.py,sha256=F6uDG6Gj7RNKQJUDnd87QKqI16Us-t-B0wPF_4QMpWc,156
+pip/_internal/commands/__init__.py,sha256=uTSj58QlrSKeXqCUSdL-eAf_APzx5BHy1ABxb0j5ZNE,3714
+pip/_internal/commands/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/check.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/completion.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/configuration.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/debug.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/download.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/freeze.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/hash.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/help.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/install.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/list.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/search.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/show.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/uninstall.cpython-38.pyc,,
+pip/_internal/commands/__pycache__/wheel.cpython-38.pyc,,
+pip/_internal/commands/check.py,sha256=mgLNYT3bd6Kmynwh4zzcBmVlFZ-urMo40jTgk6U405E,1505
+pip/_internal/commands/completion.py,sha256=UFQvq0Q4_B96z1bvnQyMOq82aPSu05RejbLmqeTZjC0,2975
+pip/_internal/commands/configuration.py,sha256=6riioZjMhsNSEct7dE-X8SobGodk3WERKJvuyjBje4Q,7226
+pip/_internal/commands/debug.py,sha256=a8llax2hRkxgK-tvwdJgaCaZCYPIx0fDvrlMDoYr8bQ,4209
+pip/_internal/commands/download.py,sha256=zX_0-IeFb4C8dxSmGHxk-6H5kehtyTSsdWpjNpAhSww,5007
+pip/_internal/commands/freeze.py,sha256=QS-4ib8jbKJ2wrDaDbTuyaB3Y_iJ5CQC2gAVHuAv9QU,3481
+pip/_internal/commands/hash.py,sha256=47teimfAPhpkaVbSDaafck51BT3XXYuL83lAqc5lOcE,1735
+pip/_internal/commands/help.py,sha256=Nhecq--ydFn80Gm1Zvbf9943EcRJfO0TnXUhsF0RO7s,1181
+pip/_internal/commands/install.py,sha256=T4P3J1rw7CQrZX4OUamtcoWMkTrJBfUe6gWpTfZW1bQ,27286
+pip/_internal/commands/list.py,sha256=2l0JiqHxjxDHNTCb2HZOjwwdo4duS1R0MsqZb6HSMKk,10660
+pip/_internal/commands/search.py,sha256=7Il8nKZ9mM7qF5jlnBoPvSIFY9f-0-5IbYoX3miTuZY,5148
+pip/_internal/commands/show.py,sha256=Vzsj2oX0JBl94MPyF3LV8YoMcigl8B2UsMM8zp0pH2s,6792
+pip/_internal/commands/uninstall.py,sha256=8mldFbrQecSoWDZRqxBgJkrlvx6Y9Iy7cs-2BIgtXt4,2983
+pip/_internal/commands/wheel.py,sha256=TMU5ZhjLo7BIZQApGPsYfoCsbGTnvP-N9jkgPJXhj1Y,7170
+pip/_internal/configuration.py,sha256=MgKrLFBJBkF3t2VJM4tvlnEspfSuS4scp_LhHWh53nY,14222
+pip/_internal/distributions/__init__.py,sha256=ECBUW5Gtu9TjJwyFLvim-i6kUMYVuikNh9I5asL6tbA,959
+pip/_internal/distributions/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/distributions/__pycache__/base.cpython-38.pyc,,
+pip/_internal/distributions/__pycache__/installed.cpython-38.pyc,,
+pip/_internal/distributions/__pycache__/sdist.cpython-38.pyc,,
+pip/_internal/distributions/__pycache__/wheel.cpython-38.pyc,,
+pip/_internal/distributions/base.py,sha256=ruprpM_L2T2HNi3KLUHlbHimZ1sWVw-3Q0Lb8O7TDAI,1425
+pip/_internal/distributions/installed.py,sha256=YqlkBKr6TVP1MAYS6SG8ojud21wVOYLMZ8jMLJe9MSU,760
+pip/_internal/distributions/sdist.py,sha256=D4XTMlCwgPlK69l62GLYkNSVTVe99fR5iAcVt2EbGok,4086
+pip/_internal/distributions/wheel.py,sha256=95uD-TfaYoq3KiKBdzk9YMN4RRqJ28LNoSTS2K46gek,1294
+pip/_internal/exceptions.py,sha256=6YRuwXAK6F1iyUWKIkCIpWWN2khkAn1sZOgrFA9S8Ro,10247
+pip/_internal/index/__init__.py,sha256=vpt-JeTZefh8a-FC22ZeBSXFVbuBcXSGiILhQZJaNpQ,30
+pip/_internal/index/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/index/__pycache__/collector.cpython-38.pyc,,
+pip/_internal/index/__pycache__/package_finder.cpython-38.pyc,,
+pip/_internal/index/collector.py,sha256=YS7Ix4oylU7ZbPTPFugh-244GSRqMvdHsGUG6nmz2gE,17892
+pip/_internal/index/package_finder.py,sha256=2Rg75AOpLj8BN1jyL8EI-Iw-Hv6ibJkrYVARCht3bX8,37542
+pip/_internal/legacy_resolve.py,sha256=L7R72I7CjVgJlPTggmA1j4b-H8NmxNu_dKVhrpGXGps,16277
+pip/_internal/locations.py,sha256=VifFEqhc7FWFV8QGoEM3CpECRY8Doq7kTytytxsEgx0,6734
+pip/_internal/main.py,sha256=IVBnUQ-FG7DK6617uEXRB5_QJqspAsBFmTmTesYkbdQ,437
+pip/_internal/models/__init__.py,sha256=3DHUd_qxpPozfzouoqa9g9ts1Czr5qaHfFxbnxriepM,63
+pip/_internal/models/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/models/__pycache__/candidate.cpython-38.pyc,,
+pip/_internal/models/__pycache__/format_control.cpython-38.pyc,,
+pip/_internal/models/__pycache__/index.cpython-38.pyc,,
+pip/_internal/models/__pycache__/link.cpython-38.pyc,,
+pip/_internal/models/__pycache__/scheme.cpython-38.pyc,,
+pip/_internal/models/__pycache__/search_scope.cpython-38.pyc,,
+pip/_internal/models/__pycache__/selection_prefs.cpython-38.pyc,,
+pip/_internal/models/__pycache__/target_python.cpython-38.pyc,,
+pip/_internal/models/__pycache__/wheel.cpython-38.pyc,,
+pip/_internal/models/candidate.py,sha256=Y58Bcm6oXUj0iS-yhmerlGo5CQJI2p0Ww9h6hR9zQDw,1150
+pip/_internal/models/format_control.py,sha256=ICzVjjGwfZYdX-eLLKHjMHLutEJlAGpfj09OG_eMqac,2673
+pip/_internal/models/index.py,sha256=K59A8-hVhBM20Xkahr4dTwP7OjkJyEqXH11UwHFVgqM,1060
+pip/_internal/models/link.py,sha256=y0H2ZOk0P6d1lfGUL2Pl09xFgZcRt5HwN2LElMifOpI,6827
+pip/_internal/models/scheme.py,sha256=vvhBrrno7eVDXcdKHiZWwxhPHf4VG5uSCEkC0QDR2RU,679
+pip/_internal/models/search_scope.py,sha256=2LXbU4wV8LwqdtXQXNXFYKv-IxiDI_QwSz9ZgbwtAfk,3898
+pip/_internal/models/selection_prefs.py,sha256=rPeif2KKjhTPXeMoQYffjqh10oWpXhdkxRDaPT1HO8k,1908
+pip/_internal/models/target_python.py,sha256=c-cFi6zCuo5HYbXNS3rVVpKRaHVh5yQlYEjEW23SidQ,3799
+pip/_internal/models/wheel.py,sha256=6KLuLKH5b0C5goWQXGSISRaq2UZtkHUEAU1y1Zsrwms,2766
+pip/_internal/network/__init__.py,sha256=jf6Tt5nV_7zkARBrKojIXItgejvoegVJVKUbhAa5Ioc,50
+pip/_internal/network/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/network/__pycache__/auth.cpython-38.pyc,,
+pip/_internal/network/__pycache__/cache.cpython-38.pyc,,
+pip/_internal/network/__pycache__/download.cpython-38.pyc,,
+pip/_internal/network/__pycache__/session.cpython-38.pyc,,
+pip/_internal/network/__pycache__/utils.cpython-38.pyc,,
+pip/_internal/network/__pycache__/xmlrpc.cpython-38.pyc,,
+pip/_internal/network/auth.py,sha256=K3G1ukKb3PiH8w_UnpXTz8qQsTULO-qdbfOE9zTo1fE,11119
+pip/_internal/network/cache.py,sha256=51CExcRkXWrgMZ7WsrZ6cmijKfViD5tVgKbBvJHO1IE,2394
+pip/_internal/network/download.py,sha256=3D9vdJmVwmCUMxzC-TaVI_GvVOpQna3BLEYNPCSx3Fc,6260
+pip/_internal/network/session.py,sha256=u1IXQfv21R1xv86ulyiB58-be4sYm90eFB0Wp8fVMYw,14702
+pip/_internal/network/utils.py,sha256=iiixo1OeaQ3niUWiBjg59PN6f1w7vvTww1vFriTD_IU,1959
+pip/_internal/network/xmlrpc.py,sha256=AL115M3vFJ8xiHVJneb8Hi0ZFeRvdPhblC89w25OG5s,1597
+pip/_internal/operations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pip/_internal/operations/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/operations/__pycache__/check.cpython-38.pyc,,
+pip/_internal/operations/__pycache__/freeze.cpython-38.pyc,,
+pip/_internal/operations/__pycache__/prepare.cpython-38.pyc,,
+pip/_internal/operations/build/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pip/_internal/operations/build/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/operations/build/__pycache__/metadata.cpython-38.pyc,,
+pip/_internal/operations/build/__pycache__/metadata_legacy.cpython-38.pyc,,
+pip/_internal/operations/build/__pycache__/wheel.cpython-38.pyc,,
+pip/_internal/operations/build/__pycache__/wheel_legacy.cpython-38.pyc,,
+pip/_internal/operations/build/metadata.py,sha256=yHMi5gHYXcXyHcvUPWHdO-UyOo3McFWljn_nHfM1O9c,1307
+pip/_internal/operations/build/metadata_legacy.py,sha256=4n6N7BTysqVmEpITzT2UVClyt0Peij_Im8Qm965IWB4,3957
+pip/_internal/operations/build/wheel.py,sha256=ntltdNP6D2Tpr4V0agssu6rE0F9LaBpJkYT6zSdhEbw,1469
+pip/_internal/operations/build/wheel_legacy.py,sha256=DYSxQKutwSZnmNvWkwsl2HzE2XQBxV0i0wTphjtUe90,3349
+pip/_internal/operations/check.py,sha256=a6uHG0daoWpmSPCdL7iYJaGQYZ-CRvPvTnCv2PnIIs0,5353
+pip/_internal/operations/freeze.py,sha256=td4BeRnW10EXFTZrx6VgygO3CrjqD5B9f0BGzjQm-Ew,10180
+pip/_internal/operations/install/__init__.py,sha256=mX7hyD2GNBO2mFGokDQ30r_GXv7Y_PLdtxcUv144e-s,51
+pip/_internal/operations/install/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/operations/install/__pycache__/editable_legacy.cpython-38.pyc,,
+pip/_internal/operations/install/__pycache__/legacy.cpython-38.pyc,,
+pip/_internal/operations/install/__pycache__/wheel.cpython-38.pyc,,
+pip/_internal/operations/install/editable_legacy.py,sha256=rJ_xs2qtDUjpY2-n6eYlVyZiNoKbOtZXZrYrcnIELt4,1488
+pip/_internal/operations/install/legacy.py,sha256=eBV8gHbO9sBlBc-4nuR3Sd2nikHgEcnC9khfeLiypio,4566
+pip/_internal/operations/install/wheel.py,sha256=xdCjH6uIUyg39Pf8tUaMFUN4a7eozJAFMb_wKcgQlsY,23012
+pip/_internal/operations/prepare.py,sha256=ro2teBlbBpkRJhBKraP9CoJgVLpueSk62ziWhRToXww,20942
+pip/_internal/pep425tags.py,sha256=SlIQokevkoKnXhoK3PZvXiDoj8hFKoJ7thDifDtga3k,5490
+pip/_internal/pyproject.py,sha256=VJKsrXORGiGoDPVKCQhuu4tWlQSTOhoiRlVLRNu4rx4,7400
+pip/_internal/req/__init__.py,sha256=UVaYPlHZVGRBQQPjvGC_6jJDQtewXm0ws-8Lxhg_TiY,2671
+pip/_internal/req/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/req/__pycache__/constructors.cpython-38.pyc,,
+pip/_internal/req/__pycache__/req_file.cpython-38.pyc,,
+pip/_internal/req/__pycache__/req_install.cpython-38.pyc,,
+pip/_internal/req/__pycache__/req_set.cpython-38.pyc,,
+pip/_internal/req/__pycache__/req_tracker.cpython-38.pyc,,
+pip/_internal/req/__pycache__/req_uninstall.cpython-38.pyc,,
+pip/_internal/req/constructors.py,sha256=w5-kWWVCqlSqcIBitw86yq7XGMPpKrHDfQZSE2mJ_xc,14388
+pip/_internal/req/req_file.py,sha256=ECqRUicCw5Y08R1YynZAAp8dSKQhDXoc1Q-mY3a9b6I,18485
+pip/_internal/req/req_install.py,sha256=wjsIr4lDpbVSLqANKJI9mXwRVHaRxcnj8q30UiHoLRA,30442
+pip/_internal/req/req_set.py,sha256=GsrKmupRKhNMhjkofVfCEHEHfgEvYBxClaQH5xLBQHg,8066
+pip/_internal/req/req_tracker.py,sha256=27fvVG8Y2MJS1KpU2rBMnQyUEMHG4lkHT_bzbzQK-c0,4723
+pip/_internal/req/req_uninstall.py,sha256=DWnOsuyYGju6-sylyoCm7GtUNevn9qMAVhjAGLcdXUE,23609
+pip/_internal/self_outdated_check.py,sha256=3KO1pTJUuYaiV9X0t87I9PimkGL82HbhLWbocqKZpBU,8009
+pip/_internal/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pip/_internal/utils/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/appdirs.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/compat.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/deprecation.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/distutils_args.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/encoding.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/entrypoints.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/filesystem.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/filetypes.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/glibc.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/hashes.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/inject_securetransport.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/logging.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/marker_files.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/misc.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/models.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/packaging.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/pkg_resources.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/setuptools_build.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/subprocess.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/temp_dir.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/typing.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/ui.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/unpacking.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/urls.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/virtualenv.cpython-38.pyc,,
+pip/_internal/utils/__pycache__/wheel.cpython-38.pyc,,
+pip/_internal/utils/appdirs.py,sha256=PVo_7-IQWHa9qNuNbWSFiF2QGqeLbSAR4eLcYYhQ9ek,1307
+pip/_internal/utils/compat.py,sha256=D7FKGLBdQwWH-dHIGaoWMawDZWBYApvtJVL1kFPJ930,8869
+pip/_internal/utils/deprecation.py,sha256=pBnNogoA4UGTxa_JDnPXBRRYpKMbExAhXpBwAwklOBs,3318
+pip/_internal/utils/distutils_args.py,sha256=a56mblNxk9BGifbpEETG61mmBrqhjtjRkJ4HYn-oOEE,1350
+pip/_internal/utils/encoding.py,sha256=hxZz0t3Whw3d4MHQEiofxalTlfKwxFdLc8fpeGfhKo8,1320
+pip/_internal/utils/entrypoints.py,sha256=vHcNpnksCv6mllihU6hfifdsKPEjwcaJ1aLIXEaynaU,1152
+pip/_internal/utils/filesystem.py,sha256=PXa3vMcz4mbEKtkD0joFI8pBwddLQxhfPFOkVH5xjfE,5255
+pip/_internal/utils/filetypes.py,sha256=R2FwzoeX7b-rZALOXx5cuO8VPPMhUQ4ne7wm3n3IcWA,571
+pip/_internal/utils/glibc.py,sha256=LOeNGgawCKS-4ke9fii78fwXD73dtNav3uxz1Bf-Ab8,3297
+pip/_internal/utils/hashes.py,sha256=my-wSnAWEDvl_8rQaOQcVIWjwh1-f_QiEvGy9TPf53U,3942
+pip/_internal/utils/inject_securetransport.py,sha256=M17ZlFVY66ApgeASVjKKLKNz0LAfk-SyU0HZ4ZB6MmI,810
+pip/_internal/utils/logging.py,sha256=aJL7NldPhS5KGFof6Qt3o3MG5cjm5TOoo7bGRu9_wsg,13033
+pip/_internal/utils/marker_files.py,sha256=CO5djQlrPIozJpJybViH_insoAaBGY1aqEt6-cC-iW0,741
+pip/_internal/utils/misc.py,sha256=uIb58Hiu_g2HRORo2aMcgnW_7R5d-5wUAuoW0fA2ZME,26085
+pip/_internal/utils/models.py,sha256=IA0hw_T4awQzui0kqfIEASm5yLtgZAB08ag59Nip5G8,1148
+pip/_internal/utils/packaging.py,sha256=VtiwcAAL7LBi7tGL2je7LeW4bE11KMHGCsJ1NZY5XtM,3035
+pip/_internal/utils/pkg_resources.py,sha256=ZX-k7V5q_aNWyDse92nN7orN1aCpRLsaxzpkBZ1XKzU,1254
+pip/_internal/utils/setuptools_build.py,sha256=DouaVolV9olDDFIIN9IszaL-FHdNaZt10ufOZFH9ZAU,5070
+pip/_internal/utils/subprocess.py,sha256=Ph3x5eHQBxFotyGhpZN8asSMBud-BBkmgaNfARG-di8,9922
+pip/_internal/utils/temp_dir.py,sha256=87Ib8aNic_hoSDEmUYJHTQIn5-prL2AYL5u_yZ3s4sI,7768
+pip/_internal/utils/typing.py,sha256=xkYwOeHlf4zsHXBDC4310HtEqwhQcYXFPq2h35Tcrl0,1401
+pip/_internal/utils/ui.py,sha256=0FNxXlGtbpPtTviv2oXS9t8bQG_NBdfUgP4GbubhS9U,13911
+pip/_internal/utils/unpacking.py,sha256=M944JTSiapBOSKLWu7lbawpVHSE7flfzZTEr3TAG7v8,9438
+pip/_internal/utils/urls.py,sha256=aNV9wq5ClUmrz6sG-al7hEWJ4ToitOy7l82CmFGFNW8,1481
+pip/_internal/utils/virtualenv.py,sha256=Q3S1WPlI7JWpGOT2jUVJ8l2chm_k7VPJ9cHA_cUluEU,3396
+pip/_internal/utils/wheel.py,sha256=grTRwZtMQwApwbbSPmRVLtac6FKy6SVKeCXNkWyyePA,7302
+pip/_internal/vcs/__init__.py,sha256=viJxJRqRE_mVScum85bgQIXAd6o0ozFt18VpC-qIJrM,617
+pip/_internal/vcs/__pycache__/__init__.cpython-38.pyc,,
+pip/_internal/vcs/__pycache__/bazaar.cpython-38.pyc,,
+pip/_internal/vcs/__pycache__/git.cpython-38.pyc,,
+pip/_internal/vcs/__pycache__/mercurial.cpython-38.pyc,,
+pip/_internal/vcs/__pycache__/subversion.cpython-38.pyc,,
+pip/_internal/vcs/__pycache__/versioncontrol.cpython-38.pyc,,
+pip/_internal/vcs/bazaar.py,sha256=84q1-kj1_nJ9AMzMu8RmMp-riRZu81M7K9kowcYgi3U,3957
+pip/_internal/vcs/git.py,sha256=CdLz3DTsZsLMLPZpEuUwiS40npvDaVB1CNRzoXgcuJQ,14352
+pip/_internal/vcs/mercurial.py,sha256=2mg7BdYI_Fe00fF6omaNccFQLPHBsDBG5CAEzvqn5sA,5110
+pip/_internal/vcs/subversion.py,sha256=Fpwy71AmuqXnoKi6h1SrXRtPjEMn8fieuM1O4j01IBg,12292
+pip/_internal/vcs/versioncontrol.py,sha256=nqoaM1_rzx24WnHtihXA8RcPpnUae0sV2sR_LS_5HFA,22600
+pip/_internal/wheel_builder.py,sha256=gr9jE14W5ZuYblpldo-tpRuyG0e0AVmHLttImuAvXlE,9441
+pip/_vendor/__init__.py,sha256=RcHf8jwLPL0ZEaa6uMhTSfyCrA_TpWgDWAW5br9xD7Y,4975
+pip/_vendor/__pycache__/__init__.cpython-38.pyc,,

+Wheel-Version: 1.0
+Generator: bdist_wheel (0.34.2)
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any
+

+[console_scripts]
+pip = pip._internal.cli.main:main
+pip3 = pip._internal.cli.main:main
+pip3.8 = pip._internal.cli.main:main
+

+pip

+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+
+if MYPY_CHECK_RUNNING:
+    from typing import List, Optional
+
+
+__version__ = "20.0.2"
+
+
+def main(args=None):
+    # type: (Optional[List[str]]) -> int
+    """This is an internal API only meant for use by pip's own console scripts.
+
+    For additional details, see https://github.com/pypa/pip/issues/7498.
+    """
+    from pip._internal.utils.entrypoints import _wrapper
+
+    return _wrapper(args)

+from __future__ import absolute_import
+
+import os
+import sys
+
+# If we are running from a wheel, add the wheel to sys.path
+# This allows the usage python pip-*.whl/pip install pip-*.whl
+if __package__ == '':
+    # __file__ is pip-*.whl/pip/__main__.py
+    # first dirname call strips of '/__main__.py', second strips off '/pip'
+    # Resulting path is the name of the wheel itself
+    # Add that to sys.path so we can import pip
+    path = os.path.dirname(os.path.dirname(__file__))
+    sys.path.insert(0, path)
+
+from pip._internal.cli.main import main as _main  # isort:skip # noqa
+
+if __name__ == '__main__':
+    sys.exit(_main())

+#!/usr/bin/env python
+import pip._internal.utils.inject_securetransport  # noqa
+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+
+if MYPY_CHECK_RUNNING:
+    from typing import Optional, List
+
+
+def main(args=None):
+    # type: (Optional[List[str]]) -> int
+    """This is preserved for old console scripts that may still be referencing
+    it.
+
+    For additional details, see https://github.com/pypa/pip/issues/7498.
+    """
+    from pip._internal.utils.entrypoints import _wrapper
+
+    return _wrapper(args)

+"""Build Environment used for isolation during sdist building
+"""
+
+# The following comment should be removed at some point in the future.
+# mypy: strict-optional=False
+# mypy: disallow-untyped-defs=False
+
+import logging
+import os
+import sys
+import textwrap
+from collections import OrderedDict
+from distutils.sysconfig import get_python_lib
+from sysconfig import get_paths
+
+from pip._vendor.pkg_resources import Requirement, VersionConflict, WorkingSet
+
+from pip import __file__ as pip_location
+from pip._internal.utils.subprocess import call_subprocess
+from pip._internal.utils.temp_dir import TempDirectory
+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+from pip._internal.utils.ui import open_spinner
+
+if MYPY_CHECK_RUNNING:
+    from typing import Tuple, Set, Iterable, Optional, List
+    from pip._internal.index.package_finder import PackageFinder
+
+logger = logging.getLogger(__name__)
+
+
+class _Prefix:
+
+    def __init__(self, path):
+        # type: (str) -> None
+        self.path = path
+        self.setup = False
+        self.bin_dir = get_paths(
+            'nt' if os.name == 'nt' else 'posix_prefix',
+            vars={'base': path, 'platbase': path}
+        )['scripts']
+        # Note: prefer distutils' sysconfig to get the
+        # library paths so PyPy is correctly supported.
+        purelib = get_python_lib(plat_specific=False, prefix=path)
+        platlib = get_python_lib(plat_specific=True, prefix=path)
+        if purelib == platlib:
+            self.lib_dirs = [purelib]
+        else:
+            self.lib_dirs = [purelib, platlib]
+
+
+class BuildEnvironment(object):
+    """Creates and manages an isolated environment to install build deps
+    """
+
+    def __init__(self):
+        # type: () -> None
+        self._temp_dir = TempDirectory(kind="build-env")
+
+        self._prefixes = OrderedDict((
+            (name, _Prefix(os.path.join(self._temp_dir.path, name)))
+            for name in ('normal', 'overlay')
+        ))
+
+        self._bin_dirs = []  # type: List[str]
+        self._lib_dirs = []  # type: List[str]
+        for prefix in reversed(list(self._prefixes.values())):
+            self._bin_dirs.append(prefix.bin_dir)
+            self._lib_dirs.extend(prefix.lib_dirs)
+
+        # Customize site to:
+        # - ensure .pth files are honored
+        # - prevent access to system site packages
+        system_sites = {
+            os.path.normcase(site) for site in (
+                get_python_lib(plat_specific=False),
+                get_python_lib(plat_specific=True),
+            )
+        }
+        self._site_dir = os.path.join(self._temp_dir.path, 'site')
+        if not os.path.exists(self._site_dir):
+            os.mkdir(self._site_dir)
+        with open(os.path.join(self._site_dir, 'sitecustomize.py'), 'w') as fp:
+            fp.write(textwrap.dedent(
+                '''
+                import os, site, sys
+
+                # First, drop system-sites related paths.
+                original_sys_path = sys.path[:]
+                known_paths = set()
+                for path in {system_sites!r}:
+                    site.addsitedir(path, known_paths=known_paths)
+                system_paths = set(
+                    os.path.normcase(path)
+                    for path in sys.path[len(original_sys_path):]
+                )
+                original_sys_path = [
+                    path for path in original_sys_path
+                    if os.path.normcase(path) not in system_paths
+                ]
+                sys.path = original_sys_path
+
+                # Second, add lib directories.
+                # ensuring .pth file are processed.
+                for path in {lib_dirs!r}:
+                    assert not path in sys.path
+                    site.addsitedir(path)
+                '''
+            ).format(system_sites=system_sites, lib_dirs=self._lib_dirs))
+
+    def __enter__(self):
+        self._save_env = {
+            name: os.environ.get(name, None)
+            for name in ('PATH', 'PYTHONNOUSERSITE', 'PYTHONPATH')
+        }
+
+        path = self._bin_dirs[:]
+        old_path = self._save_env['PATH']
+        if old_path:
+            path.extend(old_path.split(os.pathsep))
+
+        pythonpath = [self._site_dir]
+
+        os.environ.update({
+            'PATH': os.pathsep.join(path),
+            'PYTHONNOUSERSITE': '1',
+            'PYTHONPATH': os.pathsep.join(pythonpath),
+        })
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        for varname, old_value in self._save_env.items():
+            if old_value is None:
+                os.environ.pop(varname, None)
+            else:
+                os.environ[varname] = old_value
+
+    def cleanup(self):
+        # type: () -> None
+        self._temp_dir.cleanup()
+
+    def check_requirements(self, reqs):
+        # type: (Iterable[str]) -> Tuple[Set[Tuple[str, str]], Set[str]]
+        """Return 2 sets:
+            - conflicting requirements: set of (installed, wanted) reqs tuples
+            - missing requirements: set of reqs
+        """
+        missing = set()
+        conflicting = set()
+        if reqs:
+            ws = WorkingSet(self._lib_dirs)
+            for req in reqs:
+                try:
+                    if ws.find(Requirement.parse(req)) is None:
+                        missing.add(req)
+                except VersionConflict as e:
+                    conflicting.add((str(e.args[0].as_requirement()),
+                                     str(e.args[1])))
+        return conflicting, missing
+
+    def install_requirements(
+        self,
+        finder,  # type: PackageFinder
+        requirements,  # type: Iterable[str]
+        prefix_as_string,  # type: str
+        message  # type: Optional[str]
+    ):
+        # type: (...) -> None
+        prefix = self._prefixes[prefix_as_string]
+        assert not prefix.setup
+        prefix.setup = True
+        if not requirements:
+            return
+        args = [
+            sys.executable, os.path.dirname(pip_location), 'install',
+            '--ignore-installed', '--no-user', '--prefix', prefix.path,
+            '--no-warn-script-location',
+        ]  # type: List[str]
+        if logger.getEffectiveLevel() <= logging.DEBUG:
+            args.append('-v')
+        for format_control in ('no_binary', 'only_binary'):
+            formats = getattr(finder.format_control, format_control)
+            args.extend(('--' + format_control.replace('_', '-'),
+                         ','.join(sorted(formats or {':none:'}))))
+
+        index_urls = finder.index_urls
+        if index_urls:
+            args.extend(['-i', index_urls[0]])
+            for extra_index in index_urls[1:]:
+                args.extend(['--extra-index-url', extra_index])
+        else:
+            args.append('--no-index')
+        for link in finder.find_links:
+            args.extend(['--find-links', link])
+
+        for host in finder.trusted_hosts:
+            args.extend(['--trusted-host', host])
+        if finder.allow_all_prereleases:
+            args.append('--pre')
+        args.append('--')
+        args.extend(requirements)
+        with open_spinner(message) as spinner:
+            call_subprocess(args, spinner=spinner)
+
+
+class NoOpBuildEnvironment(BuildEnvironment):
+    """A no-op drop-in replacement for BuildEnvironment
+    """
+
+    def __init__(self):
+        pass
+
+    def __enter__(self):
+        pass
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        pass
+
+    def cleanup(self):
+        pass
+
+    def install_requirements(self, finder, requirements, prefix, message):
+        raise NotImplementedError()

+"""Cache Management
+"""
+
+# The following comment should be removed at some point in the future.
+# mypy: strict-optional=False
+
+import hashlib
+import json
+import logging
+import os
+
+from pip._vendor.packaging.tags import interpreter_name, interpreter_version
+from pip._vendor.packaging.utils import canonicalize_name
+
+from pip._internal.exceptions import InvalidWheelFilename
+from pip._internal.models.link import Link
+from pip._internal.models.wheel import Wheel
+from pip._internal.utils.temp_dir import TempDirectory
+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+from pip._internal.utils.urls import path_to_url
+
+if MYPY_CHECK_RUNNING:
+    from typing import Optional, Set, List, Any, Dict
+
+    from pip._vendor.packaging.tags import Tag
+
+    from pip._internal.models.format_control import FormatControl
+
+logger = logging.getLogger(__name__)
+
+
+def _hash_dict(d):
+    # type: (Dict[str, str]) -> str
+    """Return a stable sha224 of a dictionary."""
+    s = json.dumps(d, sort_keys=True, separators=(",", ":"), ensure_ascii=True)
+    return hashlib.sha224(s.encode("ascii")).hexdigest()
+
+
+class Cache(object):
+    """An abstract class - provides cache directories for data from links
+
+
+        :param cache_dir: The root of the cache.
+        :param format_control: An object of FormatControl class to limit
+            binaries being read from the cache.
+        :param allowed_formats: which formats of files the cache should store.
+            ('binary' and 'source' are the only allowed values)
+    """
+
+    def __init__(self, cache_dir, format_control, allowed_formats):
+        # type: (str, FormatControl, Set[str]) -> None
+        super(Cache, self).__init__()
+        assert not cache_dir or os.path.isabs(cache_dir)
+        self.cache_dir = cache_dir or None
+        self.format_control = format_control
+        self.allowed_formats = allowed_formats
+
+        _valid_formats = {"source", "binary"}
+        assert self.allowed_formats.union(_valid_formats) == _valid_formats
+
+    def _get_cache_path_parts_legacy(self, link):
+        # type: (Link) -> List[str]
+        """Get parts of part that must be os.path.joined with cache_dir
+
+        Legacy cache key (pip < 20) for compatibility with older caches.
+        """
+
+        # We want to generate an url to use as our cache key, we don't want to
+        # just re-use the URL because it might have other items in the fragment
+        # and we don't care about those.
+        key_parts = [link.url_without_fragment]
+        if link.hash_name is not None and link.hash is not None:
+            key_parts.append("=".join([link.hash_name, link.hash]))
+        key_url = "#".join(key_parts)
+
+        # Encode our key url with sha224, we'll use this because it has similar
+        # security properties to sha256, but with a shorter total output (and
+        # thus less secure). However the differences don't make a lot of
+        # difference for our use case here.
+        hashed = hashlib.sha224(key_url.encode()).hexdigest()
+
+        # We want to nest the directories some to prevent having a ton of top
+        # level directories where we might run out of sub directories on some
+        # FS.
+        parts = [hashed[:2], hashed[2:4], hashed[4:6], hashed[6:]]
+
+        return parts
+
+    def _get_cache_path_parts(self, link):
+        # type: (Link) -> List[str]
+        """Get parts of part that must be os.path.joined with cache_dir
+        """
+
+        # We want to generate an url to use as our cache key, we don't want to
+        # just re-use the URL because it might have other items in the fragment
+        # and we don't care about those.
+        key_parts = {"url": link.url_without_fragment}
+        if link.hash_name is not None and link.hash is not None:
+            key_parts[link.hash_name] = link.hash
+        if link.subdirectory_fragment:
+            key_parts["subdirectory"] = link.subdirectory_fragment
+
+        # Include interpreter name, major and minor version in cache key
+        # to cope with ill-behaved sdists that build a different wheel
+        # depending on the python version their setup.py is being run on,
+        # and don't encode the difference in compatibility tags.
+        # https://github.com/pypa/pip/issues/7296
+        key_parts["interpreter_name"] = interpreter_name()
+        key_parts["interpreter_version"] = interpreter_version()
+
+        # Encode our key url with sha224, we'll use this because it has similar
+        # security properties to sha256, but with a shorter total output (and
+        # thus less secure). However the differences don't make a lot of
+        # difference for our use case here.
+        hashed = _hash_dict(key_parts)
+
+        # We want to nest the directories some to prevent having a ton of top
+        # level directories where we might run out of sub directories on some
+        # FS.
+        parts = [hashed[:2], hashed[2:4], hashed[4:6], hashed[6:]]
+
+        return parts
+
+    def _get_candidates(self, link, canonical_package_name):
+        # type: (Link, Optional[str]) -> List[Any]
+        can_not_cache = (
+            not self.cache_dir or
+            not canonical_package_name or
+            not link
+        )
+        if can_not_cache:
+            return []
+
+        formats = self.format_control.get_allowed_formats(
+            canonical_package_name
+        )
+        if not self.allowed_formats.intersection(formats):
+            return []
+
+        candidates = []
+        path = self.get_path_for_link(link)
+        if os.path.isdir(path):
+            for candidate in os.listdir(path):
+                candidates.append((candidate, path))
+        # TODO remove legacy path lookup in pip>=21
+        legacy_path = self.get_path_for_link_legacy(link)
+        if os.path.isdir(legacy_path):
+            for candidate in os.listdir(legacy_path):
+                candidates.append((candidate, legacy_path))
+        return candidates
+
+    def get_path_for_link_legacy(self, link):
+        # type: (Link) -> str
+        raise NotImplementedError()
+
+    def get_path_for_link(self, link):
+        # type: (Link) -> str
+        """Return a directory to store cached items in for link.
+        """
+        raise NotImplementedError()
+
+    def get(
+        self,
+        link,            # type: Link
+        package_name,    # type: Optional[str]
+        supported_tags,  # type: List[Tag]
+    ):
+        # type: (...) -> Link
+        """Returns a link to a cached item if it exists, otherwise returns the
+        passed link.
+        """
+        raise NotImplementedError()
+
+    def cleanup(self):
+        # type: () -> None
+        pass
+
+
+class SimpleWheelCache(Cache):
+    """A cache of wheels for future installs.
+    """
+
+    def __init__(self, cache_dir, format_control):
+        # type: (str, FormatControl) -> None
+        super(SimpleWheelCache, self).__init__(
+            cache_dir, format_control, {"binary"}
+        )
+
+    def get_path_for_link_legacy(self, link):
+        # type: (Link) -> str
+        parts = self._get_cache_path_parts_legacy(link)
+        return os.path.join(self.cache_dir, "wheels", *parts)
+
+    def get_path_for_link(self, link):
+        # type: (Link) -> str
+        """Return a directory to store cached wheels for link
+
+        Because there are M wheels for any one sdist, we provide a directory
+        to cache them in, and then consult that directory when looking up
+        cache hits.
+
+        We only insert things into the cache if they have plausible version
+        numbers, so that we don't contaminate the cache with things that were
+        not unique. E.g. ./package might have dozens of installs done for it
+        and build a version of 0.0...and if we built and cached a wheel, we'd
+        end up using the same wheel even if the source has been edited.
+
+        :param link: The link of the sdist for which this will cache wheels.
+        """
+        parts = self._get_cache_path_parts(link)
+
+        # Store wheels within the root cache_dir
+        return os.path.join(self.cache_dir, "wheels", *parts)
+
+    def get(
+        self,
+        link,            # type: Link
+        package_name,    # type: Optional[str]
+        supported_tags,  # type: List[Tag]
+    ):
+        # type: (...) -> Link
+        candidates = []
+
+        if not package_name:
+            return link
+
+        canonical_package_name = canonicalize_name(package_name)
+        for wheel_name, wheel_dir in self._get_candidates(
+            link, canonical_package_name
+        ):
+            try:
+                wheel = Wheel(wheel_name)
+            except InvalidWheelFilename:
+                continue
+            if canonicalize_name(wheel.name) != canonical_package_name:
+                logger.debug(
+                    "Ignoring cached wheel {} for {} as it "
+                    "does not match the expected distribution name {}.".format(
+                        wheel_name, link, package_name
+                    )
+                )
+                continue
+            if not wheel.supported(supported_tags):
+                # Built for a different python/arch/etc
+                continue
+            candidates.append(
+                (
+                    wheel.support_index_min(supported_tags),
+                    wheel_name,
+                    wheel_dir,
+                )
+            )
+
+        if not candidates:
+            return link
+
+        _, wheel_name, wheel_dir = min(candidates)
+        return Link(path_to_url(os.path.join(wheel_dir, wheel_name)))
+
+
+class EphemWheelCache(SimpleWheelCache):
+    """A SimpleWheelCache that creates it's own temporary cache directory
+    """
+
+    def __init__(self, format_control):
+        # type: (FormatControl) -> None
+        self._temp_dir = TempDirectory(kind="ephem-wheel-cache")
+
+        super(EphemWheelCache, self).__init__(
+            self._temp_dir.path, format_control
+        )
+
+    def cleanup(self):
+        # type: () -> None
+        self._temp_dir.cleanup()
+
+
+class WheelCache(Cache):
+    """Wraps EphemWheelCache and SimpleWheelCache into a single Cache
+
+    This Cache allows for gracefully degradation, using the ephem wheel cache
+    when a certain link is not found in the simple wheel cache first.
+    """
+
+    def __init__(self, cache_dir, format_control):
+        # type: (str, FormatControl) -> None
+        super(WheelCache, self).__init__(
+            cache_dir, format_control, {'binary'}
+        )
+        self._wheel_cache = SimpleWheelCache(cache_dir, format_control)
+        self._ephem_cache = EphemWheelCache(format_control)
+
+    def get_path_for_link_legacy(self, link):
+        # type: (Link) -> str
+        return self._wheel_cache.get_path_for_link_legacy(link)
+
+    def get_path_for_link(self, link):
+        # type: (Link) -> str
+        return self._wheel_cache.get_path_for_link(link)
+
+    def get_ephem_path_for_link(self, link):
+        # type: (Link) -> str
+        return self._ephem_cache.get_path_for_link(link)
+
+    def get(
+        self,
+        link,            # type: Link
+        package_name,    # type: Optional[str]
+        supported_tags,  # type: List[Tag]
+    ):
+        # type: (...) -> Link
+        retval = self._wheel_cache.get(
+            link=link,
+            package_name=package_name,
+            supported_tags=supported_tags,
+        )
+        if retval is not link:
+            return retval
+
+        return self._ephem_cache.get(
+            link=link,
+            package_name=package_name,
+            supported_tags=supported_tags,
+        )
+
+    def cleanup(self):
+        # type: () -> None
+        self._wheel_cache.cleanup()
+        self._ephem_cache.cleanup()

+"""Subpackage containing all of pip's command line interface related code
+"""
+
+# This file intentionally does not import submodules

+"""Logic that powers autocompletion installed by ``pip completion``.
+"""
+
+import optparse
+import os
+import sys
+from itertools import chain
+
+from pip._internal.cli.main_parser import create_main_parser
+from pip._internal.commands import commands_dict, create_command
+from pip._internal.utils.misc import get_installed_distributions
+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+
+if MYPY_CHECK_RUNNING:
+    from typing import Any, Iterable, List, Optional
+
+
+def autocomplete():
+    # type: () -> None
+    """Entry Point for completion of main and subcommand options.
+    """
+    # Don't complete if user hasn't sourced bash_completion file.
+    if 'PIP_AUTO_COMPLETE' not in os.environ:
+        return
+    cwords = os.environ['COMP_WORDS'].split()[1:]
+    cword = int(os.environ['COMP_CWORD'])
+    try:
+        current = cwords[cword - 1]
+    except IndexError:
+        current = ''
+
+    parser = create_main_parser()
+    subcommands = list(commands_dict)
+    options = []
+
+    # subcommand
+    subcommand_name = None  # type: Optional[str]
+    for word in cwords:
+        if word in subcommands:
+            subcommand_name = word
+            break
+    # subcommand options
+    if subcommand_name is not None:
+        # special case: 'help' subcommand has no options
+        if subcommand_name == 'help':
+            sys.exit(1)
+        # special case: list locally installed dists for show and uninstall
+        should_list_installed = (
+            subcommand_name in ['show', 'uninstall'] and
+            not current.startswith('-')
+        )
+        if should_list_installed:
+            installed = []
+            lc = current.lower()
+            for dist in get_installed_distributions(local_only=True):
+                if dist.key.startswith(lc) and dist.key not in cwords[1:]:
+                    installed.append(dist.key)
+            # if there are no dists installed, fall back to option completion
+            if installed:
+                for dist in installed:
+                    print(dist)
+                sys.exit(1)
+
+        subcommand = create_command(subcommand_name)
+
+        for opt in subcommand.parser.option_list_all:
+            if opt.help != optparse.SUPPRESS_HELP:
+                for opt_str in opt._long_opts + opt._short_opts:
+                    options.append((opt_str, opt.nargs))
+
+        # filter out previously specified options from available options
+        prev_opts = [x.split('=')[0] for x in cwords[1:cword - 1]]
+        options = [(x, v) for (x, v) in options if x not in prev_opts]
+        # filter options by current input
+        options = [(k, v) for k, v in options if k.startswith(current)]
+        # get completion type given cwords and available subcommand options
+        completion_type = get_path_completion_type(
+            cwords, cword, subcommand.parser.option_list_all,
+        )
+        # get completion files and directories if ``completion_type`` is
+        # ``<file>``, ``<dir>`` or ``<path>``
+        if completion_type:
+            paths = auto_complete_paths(current, completion_type)
+            options = [(path, 0) for path in paths]
+        for option in options:
+            opt_label = option[0]
+            # append '=' to options which require args
+            if option[1] and option[0][:2] == "--":
+                opt_label += '='
+            print(opt_label)
+    else:
+        # show main parser options only when necessary
+
+        opts = [i.option_list for i in parser.option_groups]
+        opts.append(parser.option_list)
+        flattened_opts = chain.from_iterable(opts)
+        if current.startswith('-'):
+            for opt in flattened_opts:
+                if opt.help != optparse.SUPPRESS_HELP:
+                    subcommands += opt._long_opts + opt._short_opts
+        else:
+            # get completion type given cwords and all available options
+            completion_type = get_path_completion_type(cwords, cword,
+                                                       flattened_opts)
+            if completion_type:
+                subcommands = list(auto_complete_paths(current,
+                                                       completion_type))
+
+        print(' '.join([x for x in subcommands if x.startswith(current)]))
+    sys.exit(1)
+
+
+def get_path_completion_type(cwords, cword, opts):
+    # type: (List[str], int, Iterable[Any]) -> Optional[str]
+    """Get the type of path completion (``file``, ``dir``, ``path`` or None)
+
+    :param cwords: same as the environmental variable ``COMP_WORDS``
+    :param cword: same as the environmental variable ``COMP_CWORD``
+    :param opts: The available options to check
+    :return: path completion type (``file``, ``dir``, ``path`` or None)
+    """
+    if cword < 2 or not cwords[cword - 2].startswith('-'):
+        return None
+    for opt in opts:
+        if opt.help == optparse.SUPPRESS_HELP:
+            continue
+        for o in str(opt).split('/'):
+            if cwords[cword - 2].split('=')[0] == o:
+                if not opt.metavar or any(
+                        x in ('path', 'file', 'dir')
+                        for x in opt.metavar.split('/')):
+                    return opt.metavar
+    return None
+
+
+def auto_complete_paths(current, completion_type):
+    # type: (str, str) -> Iterable[str]
+    """If ``completion_type`` is ``file`` or ``path``, list all regular files
+    and directories starting with ``current``; otherwise only list directories
+    starting with ``current``.
+
+    :param current: The word to be completed
+    :param completion_type: path completion type(`file`, `path` or `dir`)i
+    :return: A generator of regular files and/or directories
+    """
+    directory, filename = os.path.split(current)
+    current_path = os.path.abspath(directory)
+    # Don't complete paths if they can't be accessed
+    if not os.access(current_path, os.R_OK):
+        return
+    filename = os.path.normcase(filename)
+    # list all files that start with ``filename``
+    file_list = (x for x in os.listdir(current_path)
+                 if os.path.normcase(x).startswith(filename))
+    for f in file_list:
+        opt = os.path.join(current_path, f)
+        comp_file = os.path.normcase(os.path.join(directory, f))
+        # complete regular files when there is not ``<dir>`` after option
+        # complete directories when there is ``<file>``, ``<path>`` or
+        # ``<dir>``after option
+        if completion_type != 'dir' and os.path.isfile(opt):
+            yield comp_file
+        elif os.path.isdir(opt):
+            yield os.path.join(comp_file, '')

+"""Base Command class, and related routines"""
+
+from __future__ import absolute_import, print_function
+
+import logging
+import logging.config
+import optparse
+import os
+import platform
+import sys
+import traceback
+
+from pip._internal.cli import cmdoptions
+from pip._internal.cli.command_context import CommandContextMixIn
+from pip._internal.cli.parser import (
+    ConfigOptionParser,
+    UpdatingDefaultsHelpFormatter,
+)
+from pip._internal.cli.status_codes import (
+    ERROR,
+    PREVIOUS_BUILD_DIR_ERROR,
+    SUCCESS,
+    UNKNOWN_ERROR,
+    VIRTUALENV_NOT_FOUND,
+)
+from pip._internal.exceptions import (
+    BadCommand,
+    CommandError,
+    InstallationError,
+    PreviousBuildDirError,
+    UninstallationError,
+)
+from pip._internal.utils.deprecation import deprecated
+from pip._internal.utils.filesystem import check_path_owner
+from pip._internal.utils.logging import BrokenStdoutLoggingError, setup_logging
+from pip._internal.utils.misc import get_prog, normalize_path
+from pip._internal.utils.temp_dir import global_tempdir_manager
+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+from pip._internal.utils.virtualenv import running_under_virtualenv
+
+if MYPY_CHECK_RUNNING:
+    from typing import List, Tuple, Any
+    from optparse import Values
+
+__all__ = ['Command']
+
+logger = logging.getLogger(__name__)
+
+
+class Command(CommandContextMixIn):
+    usage = None  # type: str
+    ignore_require_venv = False  # type: bool
+
+    def __init__(self, name, summary, isolated=False):
+        # type: (str, str, bool) -> None
+        super(Command, self).__init__()
+        parser_kw = {
+            'usage': self.usage,
+            'prog': '%s %s' % (get_prog(), name),
+            'formatter': UpdatingDefaultsHelpFormatter(),
+            'add_help_option': False,
+            'name': name,
+            'description': self.__doc__,
+            'isolated': isolated,
+        }
+
+        self.name = name
+        self.summary = summary
+        self.parser = ConfigOptionParser(**parser_kw)
+
+        # Commands should add options to this option group
+        optgroup_name = '%s Options' % self.name.capitalize()
+        self.cmd_opts = optparse.OptionGroup(self.parser, optgroup_name)
+
+        # Add the general options
+        gen_opts = cmdoptions.make_option_group(
+            cmdoptions.general_group,
+            self.parser,
+        )
+        self.parser.add_option_group(gen_opts)
+
+    def handle_pip_version_check(self, options):
+        # type: (Values) -> None
+        """
+        This is a no-op so that commands by default do not do the pip version
+        check.
+        """
+        # Make sure we do the pip version check if the index_group options
+        # are present.
+        assert not hasattr(options, 'no_index')
+
+    def run(self, options, args):
+        # type: (Values, List[Any]) -> Any
+        raise NotImplementedError
+
+    def parse_args(self, args):
+        # type: (List[str]) -> Tuple[Any, Any]
+        # factored out for testability
+        return self.parser.parse_args(args)
+
+    def main(self, args):
+        # type: (List[str]) -> int
+        try:
+            with self.main_context():
+                return self._main(args)
+        finally:
+            logging.shutdown()
+
+    def _main(self, args):
+        # type: (List[str]) -> int
+        # Intentionally set as early as possible so globally-managed temporary
+        # directories are available to the rest of the code.
+        self.enter_context(global_tempdir_manager())
+
+        options, args = self.parse_args(args)
+
+        # Set verbosity so that it can be used elsewhere.
+        self.verbosity = options.verbose - options.quiet
+
+        level_number = setup_logging(
+            verbosity=self.verbosity,
+            no_color=options.no_color,
+            user_log_file=options.log,
+        )
+
+        if (
+            sys.version_info[:2] == (2, 7) and
+            not options.no_python_version_warning
+        ):
+            message = (
+                "A future version of pip will drop support for Python 2.7. "
+                "More details about Python 2 support in pip, can be found at "
+                "https://pip.pypa.io/en/latest/development/release-process/#python-2-support"  # noqa
+            )
+            if platform.python_implementation() == "CPython":
+                message = (
+                    "Python 2.7 reached the end of its life on January "
+                    "1st, 2020. Please upgrade your Python as Python 2.7 "
+                    "is no longer maintained. "
+                ) + message
+            deprecated(message, replacement=None, gone_in=None)
+
+        if options.skip_requirements_regex:
+            deprecated(
+                "--skip-requirements-regex is unsupported and will be removed",
+                replacement=(
+                    "manage requirements/constraints files explicitly, "
+                    "possibly generating them from metadata"
+                ),
+                gone_in="20.1",
+                issue=7297,
+            )
+
+        # TODO: Try to get these passing down from the command?
+        #       without resorting to os.environ to hold these.
+        #       This also affects isolated builds and it should.
+
+        if options.no_input:
+            os.environ['PIP_NO_INPUT'] = '1'
+
+        if options.exists_action:
+            os.environ['PIP_EXISTS_ACTION'] = ' '.join(options.exists_action)
+
+        if options.require_venv and not self.ignore_require_venv:
+            # If a venv is required check if it can really be found
+            if not running_under_virtualenv():
+                logger.critical(
+                    'Could not find an activated virtualenv (required).'
+                )
+                sys.exit(VIRTUALENV_NOT_FOUND)
+
+        if options.cache_dir:
+            options.cache_dir = normalize_path(options.cache_dir)
+            if not check_path_owner(options.cache_dir):
+                logger.warning(
+                    "The directory '%s' or its parent directory is not owned "
+                    "or is not writable by the current user. The cache "
+                    "has been disabled. Check the permissions and owner of "
+                    "that directory. If executing pip with sudo, you may want "
+                    "sudo's -H flag.",
+                    options.cache_dir,
+                )
+                options.cache_dir = None
+
+        try:
+            status = self.run(options, args)
+            # FIXME: all commands should return an exit status
+            # and when it is done, isinstance is not needed anymore
+            if isinstance(status, int):
+                return status
+        except PreviousBuildDirError as exc:
+            logger.critical(str(exc))
+            logger.debug('Exception information:', exc_info=True)
+
+            return PREVIOUS_BUILD_DIR_ERROR
+        except (InstallationError, UninstallationError, BadCommand) as exc:
+            logger.critical(str(exc))
+            logger.debug('Exception information:', exc_info=True)
+
+            return ERROR
+        except CommandError as exc:
+            logger.critical('%s', exc)
+            logger.debug('Exception information:', exc_info=True)
+
+            return ERROR
+        except BrokenStdoutLoggingError:
+            # Bypass our logger and write any remaining messages to stderr
+            # because stdout no longer works.
+            print('ERROR: Pipe to stdout was broken', file=sys.stderr)
+            if level_number <= logging.DEBUG:
+                traceback.print_exc(file=sys.stderr)
+
+            return ERROR
+        except KeyboardInterrupt:
+            logger.critical('Operation cancelled by user')
+            logger.debug('Exception information:', exc_info=True)
+
+            return ERROR
+        except BaseException:
+            logger.critical('Exception:', exc_info=True)
+
+            return UNKNOWN_ERROR
+        finally:
+            self.handle_pip_version_check(options)
+
+        return SUCCESS

+"""
+shared options and groups
+
+The principle here is to define options once, but *not* instantiate them
+globally. One reason being that options with action='append' can carry state
+between parses. pip parses general options twice internally, and shouldn't
+pass on state. To be consistent, all options will follow this design.
+"""
+
+# The following comment should be removed at some point in the future.
+# mypy: strict-optional=False
+
+from __future__ import absolute_import
+
+import logging
+import os
+import textwrap
+import warnings
+from distutils.util import strtobool
+from functools import partial
+from optparse import SUPPRESS_HELP, Option, OptionGroup
+from textwrap import dedent
+
+from pip._internal.exceptions import CommandError
+from pip._internal.locations import USER_CACHE_DIR, get_src_prefix
+from pip._internal.models.format_control import FormatControl
+from pip._internal.models.index import PyPI
+from pip._internal.models.target_python import TargetPython
+from pip._internal.utils.hashes import STRONG_HASHES
+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+from pip._internal.utils.ui import BAR_TYPES
+
+if MYPY_CHECK_RUNNING:
+    from typing import Any, Callable, Dict, Optional, Tuple
+    from optparse import OptionParser, Values
+    from pip._internal.cli.parser import ConfigOptionParser
+
+logger = logging.getLogger(__name__)
+
+
+def raise_option_error(parser, option, msg):
+    # type: (OptionParser, Option, str) -> None
+    """
+    Raise an option parsing error using parser.error().
+
+    Args:
+      parser: an OptionParser instance.
+      option: an Option instance.
+      msg: the error text.
+    """
+    msg = '{} error: {}'.format(option, msg)
+    msg = textwrap.fill(' '.join(msg.split()))
+    parser.error(msg)
+
+
+def make_option_group(group, parser):
+    # type: (Dict[str, Any], ConfigOptionParser) -> OptionGroup
+    """
+    Return an OptionGroup object
+    group  -- assumed to be dict with 'name' and 'options' keys
+    parser -- an optparse Parser
+    """
+    option_group = OptionGroup(parser, group['name'])
+    for option in group['options']:
+        option_group.add_option(option())
+    return option_group
+
+
+def check_install_build_global(options, check_options=None):
+    # type: (Values, Optional[Values]) -> None
+    """Disable wheels if per-setup.py call options are set.
+
+    :param options: The OptionParser options to update.
+    :param check_options: The options to check, if not supplied defaults to
+        options.
+    """
+    if check_options is None:
+        check_options = options
+
+    def getname(n):
+        # type: (str) -> Optional[Any]
+        return getattr(check_options, n, None)
+    names = ["build_options", "global_options", "install_options"]
+    if any(map(getname, names)):
+        control = options.format_control
+        control.disallow_binaries()
+        warnings.warn(
+            'Disabling all use of wheels due to the use of --build-option '
+            '/ --global-option / --install-option.', stacklevel=2,
+        )
+
+
+def check_dist_restriction(options, check_target=False):
+    # type: (Values, bool) -> None
+    """Function for determining if custom platform options are allowed.
+
+    :param options: The OptionParser options.
+    :param check_target: Whether or not to check if --target is being used.
+    """
+    dist_restriction_set = any([
+        options.python_version,
+        options.platform,
+        options.abi,
+        options.implementation,
+    ])
+
+    binary_only = FormatControl(set(), {':all:'})
+    sdist_dependencies_allowed = (
+        options.format_control != binary_only and
+        not options.ignore_dependencies
+    )
+
+    # Installations or downloads using dist restrictions must not combine
+    # source distributions and dist-specific wheels, as they are not
+    # guaranteed to be locally compatible.
+    if dist_restriction_set and sdist_dependencies_allowed:
+        raise CommandError(
+            "When restricting platform and interpreter constraints using "
+            "--python-version, --platform, --abi, or --implementation, "
+            "either --no-deps must be set, or --only-binary=:all: must be "
+            "set and --no-binary must not be set (or must be set to "
+            ":none:)."
+        )
+
+    if check_target:
+        if dist_restriction_set and not options.target_dir:
+            raise CommandError(
+                "Can not use any platform or abi specific options unless "
+                "installing via '--target'"
+            )
+
+
+def _path_option_check(option, opt, value):
+    # type: (Option, str, str) -> str
+    return os.path.expanduser(value)
+
+
+class PipOption(Option):
+    TYPES = Option.TYPES + ("path",)
+    TYPE_CHECKER = Option.TYPE_CHECKER.copy()
+    TYPE_CHECKER["path"] = _path_option_check
+
+
+###########
+# options #
+###########
+
+help_ = partial(
+    Option,
+    '-h', '--help',
+    dest='help',
+    action='help',
+    help='Show help.',
+)  # type: Callable[..., Option]
+
+isolated_mode = partial(
+    Option,
+    "--isolated",
+    dest="isolated_mode",
+    action="store_true",
+    default=False,
+    help=(
+        "Run pip in an isolated mode, ignoring environment variables and user "
+        "configuration."
+    ),
+)  # type: Callable[..., Option]
+
+require_virtualenv = partial(
+    Option,
+    # Run only if inside a virtualenv, bail if not.
+    '--require-virtualenv', '--require-venv',
+    dest='require_venv',
+    action='store_true',
+    default=False,
+    help=SUPPRESS_HELP
+)  # type: Callable[..., Option]
+
+verbose = partial(
+    Option,
+    '-v', '--verbose',
+    dest='verbose',
+    action='count',
+    default=0,
+    help='Give more output. Option is additive, and can be used up to 3 times.'
+)  # type: Callable[..., Option]
+
+no_color = partial(
+    Option,
+    '--no-color',
+    dest='no_color',
+    action='store_true',
+    default=False,
+    help="Suppress colored output",
+)  # type: Callable[..., Option]
+
+version = partial(
+    Option,
+    '-V', '--version',
+    dest='version',
+    action='store_true',
+    help='Show version and exit.',
+)  # type: Callable[..., Option]
+
+quiet = partial(
+    Option,
+    '-q', '--quiet',
+    dest='quiet',
+    action='count',
+    default=0,
+    help=(
+        'Give less output. Option is additive, and can be used up to 3'
+        ' times (corresponding to WARNING, ERROR, and CRITICAL logging'
+        ' levels).'
+    ),
+)  # type: Callable[..., Option]
+
+progress_bar = partial(
+    Option,
+    '--progress-bar',
+    dest='progress_bar',
+    type='choice',
+    choices=list(BAR_TYPES.keys()),
+    default='on',
+    help=(
+        'Specify type of progress to be displayed [' +
+        '|'.join(BAR_TYPES.keys()) + '] (default: %default)'
+    ),
+)  # type: Callable[..., Option]
+
+log = partial(
+    PipOption,
+    "--log", "--log-file", "--local-log",
+    dest="log",
+    metavar="path",
+    type="path",
+    help="Path to a verbose appending log."
+)  # type: Callable[..., Option]
+
+no_input = partial(
+    Option,
+    # Don't ask for input
+    '--no-input',
+    dest='no_input',
+    action='store_true',
+    default=False,
+    help=SUPPRESS_HELP
+)  # type: Callable[..., Option]
+
+proxy = partial(
+    Option,
+    '--proxy',
+    dest='proxy',
+    type='str',
+    default='',
+    help="Specify a proxy in the form [user:passwd@]proxy.server:port."
+)  # type: Callable[..., Option]
+
+retries = partial(
+    Option,
+    '--retries',
+    dest='retries',
+    type='int',
+    default=5,
+    help="Maximum number of retries each connection should attempt "
+         "(default %default times).",
+)  # type: Callable[..., Option]
+
+timeout = partial(
+    Option,
+    '--timeout', '--default-timeout',
+    metavar='sec',
+    dest='timeout',
+    type='float',
+    default=15,
+    help='Set the socket timeout (default %default seconds).',
+)  # type: Callable[..., Option]
+
+skip_requirements_regex = partial(
+    Option,
+    # A regex to be used to skip requirements
+    '--skip-requirements-regex',
+    dest='skip_requirements_regex',
+    type='str',
+    default='',
+    help=SUPPRESS_HELP,
+)  # type: Callable[..., Option]
+
+
+def exists_action():
+    # type: () -> Option
+    return Option(
+        # Option when path already exist
+        '--exists-action',
+        dest='exists_action',
+        type='choice',
+        choices=['s', 'i', 'w', 'b', 'a'],
+        default=[],
+        action='append',
+        metavar='action',
+        help="Default action when a path already exists: "
+             "(s)witch, (i)gnore, (w)ipe, (b)ackup, (a)bort.",
+    )
+
+
+cert = partial(
+    PipOption,
+    '--cert',
+    dest='cert',
+    type='path',
+    metavar='path',
+    help="Path to alternate CA bundle.",
+)  # type: Callable[..., Option]
+
+client_cert = partial(
+    PipOption,
+    '--client-cert',
+    dest='client_cert',
+    type='path',
+    default=None,
+    metavar='path',
+    help="Path to SSL client certificate, a single file containing the "
+         "private key and the certificate in PEM format.",
+)  # type: Callable[..., Option]
+
+index_url = partial(
+    Option,
+    '-i', '--index-url', '--pypi-url',
+    dest='index_url',
+    metavar='URL',
+    default=PyPI.simple_url,
+    help="Base URL of the Python Package Index (default %default). "
+         "This should point to a repository compliant with PEP 503 "
+         "(the simple repository API) or a local directory laid out "
+         "in the same format.",
+)  # type: Callable[..., Option]
+
+
+def extra_index_url():
+    # type: () -> Option
+    return Option(
+        '--extra-index-url',
+        dest='extra_index_urls',
+        metavar='URL',
+        action='append',
+        default=[],
+        help="Extra URLs of package indexes to use in addition to "
+             "--index-url. Should follow the same rules as "
+             "--index-url.",
+    )
+
+
+no_index = partial(
+    Option,
+    '--no-index',
+    dest='no_index',
+    action='store_true',
+    default=False,
+    help='Ignore package index (only looking at --find-links URLs instead).',
+)  # type: Callable[..., Option]
+
+
+def find_links():
+    # type: () -> Option
+    return Option(
+        '-f', '--find-links',
+        dest='find_links',
+        action='append',
+        default=[],
+        metavar='url',
+        help="If a url or path to an html file, then parse for links to "
+             "archives. If a local path or file:// url that's a directory, "
+             "then look for archives in the directory listing.",
+    )
+
+
+def trusted_host():
+    # type: () -> Option
+    return Option(
+        "--trusted-host",
+        dest="trusted_hosts",
+        action="append",
+        metavar="HOSTNAME",
+        default=[],
+        help="Mark this host or host:port pair as trusted, even though it "
+             "does not have valid or any HTTPS.",
+    )
+
+
+def constraints():
+    # type: () -> Option
+    return Option(
+        '-c', '--constraint',
+        dest='constraints',
+        action='append',
+        default=[],
+        metavar='file',
+        help='Constrain versions using the given constraints file. '
+        'This option can be used multiple times.'
+    )
+
+
+def requirements():
+    # type: () -> Option
+    return Option(
+        '-r', '--requirement',
+        dest='requirements',
+        action='append',
+        default=[],
+        metavar='file',
+        help='Install from the given requirements file. '
+        'This option can be used multiple times.'
+    )
+
+
+def editable():
+    # type: () -> Option
+    return Option(
+        '-e', '--editable',
+        dest='editables',
+        action='append',
+        default=[],
+        metavar='path/url',
+        help=('Install a project in editable mode (i.e. setuptools '
+              '"develop mode") from a local project path or a VCS url.'),
+    )
+
+
+def _handle_src(option, opt_str, value, parser):
+    # type: (Option, str, str, OptionParser) -> None
+    value = os.path.abspath(value)
+    setattr(parser.values, option.dest, value)
+
+
+src = partial(
+    PipOption,
+    '--src', '--source', '--source-dir', '--source-directory',
+    dest='src_dir',
+    type='path',
+    metavar='dir',
+    default=get_src_prefix(),
+    action='callback',
+    callback=_handle_src,
+    help='Directory to check out editable projects into. '
+    'The default in a virtualenv is "<venv path>/src". '
+    'The default for global installs is "<current dir>/src".'
+)  # type: Callable[..., Option]
+
+
+def _get_format_control(values, option):
+    # type: (Values, Option) -> Any
+    """Get a format_control object."""
+    return getattr(values, option.dest)
+
+
+def _handle_no_binary(option, opt_str, value, parser):
+    # type: (Option, str, str, OptionParser) -> None
+    existing = _get_format_control(parser.values, option)
+    FormatControl.handle_mutual_excludes(
+        value, existing.no_binary, existing.only_binary,
+    )
+
+
+def _handle_only_binary(option, opt_str, value, parser):
+    # type: (Option, str, str, OptionParser) -> None
+    existing = _get_format_control(parser.values, option)
+    FormatControl.handle_mutual_excludes(
+        value, existing.only_binary, existing.no_binary,
+    )
+
+
+def no_binary():
+    # type: () -> Option
+    format_control = FormatControl(set(), set())
+    return Option(
+        "--no-binary", dest="format_control", action="callback",
+        callback=_handle_no_binary, type="str",
+        default=format_control,
+        help="Do not use binary packages. Can be supplied multiple times, and "
+             "each time adds to the existing value. Accepts either :all: to "
+             "disable all binary packages, :none: to empty the set, or one or "
+             "more package names with commas between them (no colons). Note "
+             "that some packages are tricky to compile and may fail to "
+             "install when this option is used on them.",
+    )
+
+
+def only_binary():
+    # type: () -> Option
+    format_control = FormatControl(set(), set())
+    return Option(
+        "--only-binary", dest="format_control", action="callback",
+        callback=_handle_only_binary, type="str",
+        default=format_control,
+        help="Do not use source packages. Can be supplied multiple times, and "
+             "each time adds to the existing value. Accepts either :all: to "
+             "disable all source packages, :none: to empty the set, or one or "
+             "more package names with commas between them. Packages without "
+             "binary distributions will fail to install when this option is "
+             "used on them.",
+    )
+
+
+platform = partial(
+    Option,
+    '--platform',
+    dest='platform',
+    metavar='platform',
+    default=None,
+    help=("Only use wheels compatible with <platform>. "
+          "Defaults to the platform of the running system."),
+)  # type: Callable[..., Option]
+
+
+# This was made a separate function for unit-testing purposes.
+def _convert_python_version(value):
+    # type: (str) -> Tuple[Tuple[int, ...], Optional[str]]
+    """
+    Convert a version string like "3", "37", or "3.7.3" into a tuple of ints.
+
+    :return: A 2-tuple (version_info, error_msg), where `error_msg` is
+        non-None if and only if there was a parsing error.
+    """
+    if not value:
+        # The empty string is the same as not providing a value.
+        return (None, None)
+
+    parts = value.split('.')
+    if len(parts) > 3:
+        return ((), 'at most three version parts are allowed')
+
+    if len(parts) == 1:
+        # Then we are in the case of "3" or "37".
+        value = parts[0]
+        if len(value) > 1:
+            parts = [value[0], value[1:]]
+
+    try:
+        version_info = tuple(int(part) for part in parts)
+    except ValueError:
+        return ((), 'each version part must be an integer')
+
+    return (version_info, None)
+
+
+def _handle_python_version(option, opt_str, value, parser):
+    # type: (Option, str, str, OptionParser) -> None
+    """
+    Handle a provided --python-version value.
+    """
+    version_info, error_msg = _convert_python_version(value)
+    if error_msg is not None:
+        msg = (
+            'invalid --python-version value: {!r}: {}'.format(
+                value, error_msg,
+            )
+        )
+        raise_option_error(parser, option=option, msg=msg)
+
+    parser.values.python_version = version_info
+
+
+python_version = partial(
+    Option,
+    '--python-version',
+    dest='python_version',
+    metavar='python_version',
+    action='callback',
+    callback=_handle_python_version, type='str',
+    default=None,
+    help=dedent("""\
+    The Python interpreter version to use for wheel and "Requires-Python"
+    compatibility checks. Defaults to a version derived from the running
+    interpreter. The version can be specified using up to three dot-separated
+    integers (e.g. "3" for 3.0.0, "3.7" for 3.7.0, or "3.7.3"). A major-minor
+    version can also be given as a string without dots (e.g. "37" for 3.7.0).
+    """),
+)  # type: Callable[..., Option]
+
+
+implementation = partial(
+    Option,
+    '--implementation',
+    dest='implementation',
+    metavar='implementation',
+    default=None,
+    help=("Only use wheels compatible with Python "
+          "implementation <implementation>, e.g. 'pp', 'jy', 'cp', "
+          " or 'ip'. If not specified, then the current "
+          "interpreter implementation is used.  Use 'py' to force "
+          "implementation-agnostic wheels."),
+)  # type: Callable[..., Option]
+
+
+abi = partial(
+    Option,
+    '--abi',
+    dest='abi',
+    metavar='abi',
+    default=None,
+    help=("Only use wheels compatible with Python "
+          "abi <abi>, e.g. 'pypy_41'.  If not specified, then the "
+          "current interpreter abi tag is used.  Generally "
+          "you will need to specify --implementation, "
+          "--platform, and --python-version when using "
+          "this option."),
+)  # type: Callable[..., Option]
+
+
+def add_target_python_options(cmd_opts):
+    # type: (OptionGroup) -> None
+    cmd_opts.add_option(platform())
+    cmd_opts.add_option(python_version())
+    cmd_opts.add_option(implementation())
+    cmd_opts.add_option(abi())
+
+
+def make_target_python(options):
+    # type: (Values) -> TargetPython
+    target_python = TargetPython(
+        platform=options.platform,
+        py_version_info=options.python_version,
+        abi=options.abi,
+        implementation=options.implementation,
+    )
+
+    return target_python
+
+
+def prefer_binary():
+    # type: () -> Option
+    return Option(
+        "--prefer-binary",
+        dest="prefer_binary",
+        action="store_true",
+        default=False,
+        help="Prefer older binary packages over newer source packages."
+    )
+
+
+cache_dir = partial(
+    PipOption,
+    "--cache-dir",
+    dest="cache_dir",
+    default=USER_CACHE_DIR,
+    metavar="dir",
+    type='path',
+    help="Store the cache data in <dir>."
+)  # type: Callable[..., Option]
+
+
+def _handle_no_cache_dir(option, opt, value, parser):
+    # type: (Option, str, str, OptionParser) -> None
+    """
+    Process a value provided for the --no-cache-dir option.
+
+    This is an optparse.Option callback for the --no-cache-dir option.
+    """
+    # The value argument will be None if --no-cache-dir is passed via the
+    # command-line, since the option doesn't accept arguments.  However,
+    # the value can be non-None if the option is triggered e.g. by an
+    # environment variable, like PIP_NO_CACHE_DIR=true.
+    if value is not None:
+        # Then parse the string value to get argument error-checking.
+        try:
+            strtobool(value)
+        except ValueError as exc:
+            raise_option_error(parser, option=option, msg=str(exc))
+
+    # Originally, setting PIP_NO_CACHE_DIR to a value that strtobool()
+    # converted to 0 (like "false" or "no") caused cache_dir to be disabled
+    # rather than enabled (logic would say the latter).  Thus, we disable
+    # the cache directory not just on values that parse to True, but (for
+    # backwards compatibility reasons) also on values that parse to False.
+    # In other words, always set it to False if the option is provided in
+    # some (valid) form.
+    parser.values.cache_dir = False
+
+
+no_cache = partial(
+    Option,
+    "--no-cache-dir",
+    dest="cache_dir",
+    action="callback",
+    callback=_handle_no_cache_dir,
+    help="Disable the cache.",
+)  # type: Callable[..., Option]
+
+no_deps = partial(
+    Option,
+    '--no-deps', '--no-dependencies',
+    dest='ignore_dependencies',
+    action='store_true',
+    default=False,
+    help="Don't install package dependencies.",
+)  # type: Callable[..., Option]
+
+
+def _handle_build_dir(option, opt, value, parser):
+    # type: (Option, str, str, OptionParser) -> None
+    if value:
+        value = os.path.abspath(value)
+    setattr(parser.values, option.dest, value)
+
+
+build_dir = partial(
+    PipOption,
+    '-b', '--build', '--build-dir', '--build-directory',
+    dest='build_dir',
+    type='path',
+    metavar='dir',
+    action='callback',
+    callback=_handle_build_dir,
+    help='Directory to unpack packages into and build in. Note that '
+         'an initial build still takes place in a temporary directory. '
+         'The location of temporary directories can be controlled by setting '
+         'the TMPDIR environment variable (TEMP on Windows) appropriately. '
+         'When passed, build directories are not cleaned in case of failures.'
+)  # type: Callable[..., Option]
+
+ignore_requires_python = partial(
+    Option,
+    '--ignore-requires-python',
+    dest='ignore_requires_python',
+    action='store_true',
+    help='Ignore the Requires-Python information.'
+)  # type: Callable[..., Option]
+
+no_build_isolation = partial(
+    Option,
+    '--no-build-isolation',
+    dest='build_isolation',
+    action='store_false',
+    default=True,
+    help='Disable isolation when building a modern source distribution. '
+         'Build dependencies specified by PEP 518 must be already installed '
+         'if this option is used.'
+)  # type: Callable[..., Option]
+
+
+def _handle_no_use_pep517(option, opt, value, parser):
+    # type: (Option, str, str, OptionParser) -> None
+    """
+    Process a value provided for the --no-use-pep517 option.
+
+    This is an optparse.Option callback for the no_use_pep517 option.
+    """
+    # Since --no-use-pep517 doesn't accept arguments, the value argument
+    # will be None if --no-use-pep517 is passed via the command-line.
+    # However, the value can be non-None if the option is triggered e.g.
+    # by an environment variable, for example "PIP_NO_USE_PEP517=true".
+    if value is not None:
+        msg = """A value was passed for --no-use-pep517,
+        probably using either the PIP_NO_USE_PEP517 environment variable
+        or the "no-use-pep517" config file option. Use an appropriate value
+        of the PIP_USE_PEP517 environment variable or the "use-pep517"
+        config file option instead.
+        """
+        raise_option_error(parser, option=option, msg=msg)
+
+    # Otherwise, --no-use-pep517 was passed via the command-line.
+    parser.values.use_pep517 = False
+
+
+use_pep517 = partial(
+    Option,
+    '--use-pep517',
+    dest='use_pep517',
+    action='store_true',
+    default=None,
+    help='Use PEP 517 for building source distributions '
+         '(use --no-use-pep517 to force legacy behaviour).'
+)  # type: Any
+
+no_use_pep517 = partial(
+    Option,
+    '--no-use-pep517',
+    dest='use_pep517',
+    action='callback',
+    callback=_handle_no_use_pep517,
+    default=None,
+    help=SUPPRESS_HELP
+)  # type: Any
+
+install_options = partial(
+    Option,
+    '--install-option',
+    dest='install_options',
+    action='append',
+    metavar='options',
+    help="Extra arguments to be supplied to the setup.py install "
+         "command (use like --install-option=\"--install-scripts=/usr/local/"
+         "bin\"). Use multiple --install-option options to pass multiple "
+         "options to setup.py install. If you are using an option with a "
+         "directory path, be sure to use absolute path.",
+)  # type: Callable[..., Option]
+
+global_options = partial(
+    Option,
+    '--global-option',
+    dest='global_options',
+    action='append',
+    metavar='options',
+    help="Extra global options to be supplied to the setup.py "
+         "call before the install command.",
+)  # type: Callable[..., Option]
+
+no_clean = partial(
+    Option,
+    '--no-clean',
+    action='store_true',
+    default=False,
+    help="Don't clean up build directories."
+)  # type: Callable[..., Option]
+
+pre = partial(
+    Option,
+    '--pre',
+    action='store_true',
+    default=False,
+    help="Include pre-release and development versions. By default, "
+         "pip only finds stable versions.",
+)  # type: Callable[..., Option]
+
+disable_pip_version_check = partial(
+    Option,
+    "--disable-pip-version-check",
+    dest="disable_pip_version_check",
+    action="store_true",
+    default=True,
+    help="Don't periodically check PyPI to determine whether a new version "
+         "of pip is available for download. Implied with --no-index.",
+)  # type: Callable[..., Option]
+
+
+# Deprecated, Remove later
+always_unzip = partial(
+    Option,
+    '-Z', '--always-unzip',
+    dest='always_unzip',
+    action='store_true',
+    help=SUPPRESS_HELP,
+)  # type: Callable[..., Option]
+
+
+def _handle_merge_hash(option, opt_str, value, parser):
+    # type: (Option, str, str, OptionParser) -> None
+    """Given a value spelled "algo:digest", append the digest to a list
+    pointed to in a dict by the algo name."""
+    if not parser.values.hashes:
+        parser.values.hashes = {}
+    try:
+        algo, digest = value.split(':', 1)
+    except ValueError:
+        parser.error('Arguments to %s must be a hash name '
+                     'followed by a value, like --hash=sha256:abcde...' %
+                     opt_str)
+    if algo not in STRONG_HASHES:
+        parser.error('Allowed hash algorithms for %s are %s.' %
+                     (opt_str, ', '.join(STRONG_HASHES)))
+    parser.values.hashes.setdefault(algo, []).append(digest)
+
+
+hash = partial(
+    Option,
+    '--hash',
+    # Hash values eventually end up in InstallRequirement.hashes due to
+    # __dict__ copying in process_line().
+    dest='hashes',
+    action='callback',
+    callback=_handle_merge_hash,
+    type='string',
+    help="Verify that the package's archive matches this "
+         'hash before installing. Example: --hash=sha256:abcdef...',
+)  # type: Callable[..., Option]
+
+
+require_hashes = partial(
+    Option,
+    '--require-hashes',
+    dest='require_hashes',
+    action='store_true',
+    default=False,
+    help='Require a hash to check each requirement against, for '
+         'repeatable installs. This option is implied when any package in a '
+         'requirements file has a --hash option.',
+)  # type: Callable[..., Option]
+
+
+list_path = partial(
+    PipOption,
+    '--path',
+    dest='path',
+    type='path',
+    action='append',
+    help='Restrict to the specified installation path for listing '
+         'packages (can be used multiple times).'
+)  # type: Callable[..., Option]
+
+
+def check_list_path_option(options):
+    # type: (Values) -> None
+    if options.path and (options.user or options.local):
+        raise CommandError(
+            "Cannot combine '--path' with '--user' or '--local'"
+        )
+
+
+no_python_version_warning = partial(
+    Option,
+    '--no-python-version-warning',
+    dest='no_python_version_warning',
+    action='store_true',
+    default=False,
+    help='Silence deprecation warnings for upcoming unsupported Pythons.',
+)  # type: Callable[..., Option]
+
+
+##########
+# groups #
+##########
+
+general_group = {
+    'name': 'General Options',
+    'options': [
+        help_,
+        isolated_mode,
+        require_virtualenv,
+        verbose,
+        version,
+        quiet,
+        log,
+        no_input,
+        proxy,
+        retries,
+        timeout,
+        skip_requirements_regex,
+        exists_action,
+        trusted_host,
+        cert,
+        client_cert,
+        cache_dir,
+        no_cache,
+        disable_pip_version_check,
+        no_color,
+        no_python_version_warning,
+    ]
+}  # type: Dict[str, Any]
+
+index_group = {
+    'name': 'Package Index Options',
+    'options': [
+        index_url,
+        extra_index_url,
+        no_index,
+        find_links,
+    ]
+}  # type: Dict[str, Any]

+from contextlib import contextmanager
+
+from pip._vendor.contextlib2 import ExitStack
+
+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+
+if MYPY_CHECK_RUNNING:
+    from typing import Iterator, ContextManager, TypeVar
+
+    _T = TypeVar('_T', covariant=True)
+
+
+class CommandContextMixIn(object):
+    def __init__(self):
+        # type: () -> None
+        super(CommandContextMixIn, self).__init__()
+        self._in_main_context = False
+        self._main_context = ExitStack()
+
+    @contextmanager
+    def main_context(self):
+        # type: () -> Iterator[None]
+        assert not self._in_main_context
+
+        self._in_main_context = True
+        try:
+            with self._main_context:
+                yield
+        finally:
+            self._in_main_context = False
+
+    def enter_context(self, context_provider):
+        # type: (ContextManager[_T]) -> _T
+        assert self._in_main_context
+
+        return self._main_context.enter_context(context_provider)

+"""Primary application entrypoint.
+"""
+from __future__ import absolute_import
+
+import locale
+import logging
+import os
+import sys
+
+from pip._internal.cli.autocompletion import autocomplete
+from pip._internal.cli.main_parser import parse_command
+from pip._internal.commands import create_command
+from pip._internal.exceptions import PipError
+from pip._internal.utils import deprecation
+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+
+if MYPY_CHECK_RUNNING:
+    from typing import List, Optional
+
+logger = logging.getLogger(__name__)
+
+
+# Do not import and use main() directly! Using it directly is actively
+# discouraged by pip's maintainers. The name, location and behavior of
+# this function is subject to change, so calling it directly is not
+# portable across different pip versions.
+
+# In addition, running pip in-process is unsupported and unsafe. This is
+# elaborated in detail at
+# https://pip.pypa.io/en/stable/user_guide/#using-pip-from-your-program.
+# That document also provides suggestions that should work for nearly
+# all users that are considering importing and using main() directly.
+
+# However, we know that certain users will still want to invoke pip
+# in-process. If you understand and accept the implications of using pip
+# in an unsupported manner, the best approach is to use runpy to avoid
+# depending on the exact location of this entry point.
+
+# The following example shows how to use runpy to invoke pip in that
+# case:
+#
+#     sys.argv = ["pip", your, args, here]
+#     runpy.run_module("pip", run_name="__main__")
+#
+# Note that this will exit the process after running, unlike a direct
+# call to main. As it is not safe to do any processing after calling
+# main, this should not be an issue in practice.
+
+def main(args=None):
+    # type: (Optional[List[str]]) -> int
+    if args is None:
+        args = sys.argv[1:]
+
+    # Configure our deprecation warnings to be sent through loggers
+    deprecation.install_warning_logger()
+
+    autocomplete()
+
+    try:
+        cmd_name, cmd_args = parse_command(args)
+    except PipError as exc:
+        sys.stderr.write("ERROR: %s" % exc)
+        sys.stderr.write(os.linesep)
+        sys.exit(1)
+
+    # Needed for locale.getpreferredencoding(False) to work
+    # in pip._internal.utils.encoding.auto_decode
+    try:
+        locale.setlocale(locale.LC_ALL, '')
+    except locale.Error as e:
+        # setlocale can apparently crash if locale are uninitialized
+        logger.debug("Ignoring error %s when setting locale", e)
+    command = create_command(cmd_name, isolated=("--isolated" in cmd_args))
+
+    return command.main(cmd_args)

+"""A single place for constructing and exposing the main parser
+"""
+
+import os
+import sys
+
+from pip._internal.cli import cmdoptions
+from pip._internal.cli.parser import (
+    ConfigOptionParser,
+    UpdatingDefaultsHelpFormatter,
+)
+from pip._internal.commands import commands_dict, get_similar_commands
+from pip._internal.exceptions import CommandError
+from pip._internal.utils.misc import get_pip_version, get_prog
+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+
+if MYPY_CHECK_RUNNING:
+    from typing import Tuple, List
+
+
+__all__ = ["create_main_parser", "parse_command"]
+
+
+def create_main_parser():
+    # type: () -> ConfigOptionParser
+    """Creates and returns the main parser for pip's CLI
+    """
+
+    parser_kw = {
+        'usage': '\n%prog <command> [options]',
+        'add_help_option': False,
+        'formatter': UpdatingDefaultsHelpFormatter(),
+        'name': 'global',
+        'prog': get_prog(),
+    }
+
+    parser = ConfigOptionParser(**parser_kw)
+    parser.disable_interspersed_args()
+
+    parser.version = get_pip_version()
+
+    # add the general options
+    gen_opts = cmdoptions.make_option_group(cmdoptions.general_group, parser)
+    parser.add_option_group(gen_opts)
+
+    # so the help formatter knows
+    parser.main = True  # type: ignore
+
+    # create command listing for description
+    description = [''] + [
+        '%-27s %s' % (name, command_info.summary)
+        for name, command_info in commands_dict.items()
+    ]
+    parser.description = '\n'.join(description)
+
+    return parser
+
+
+def parse_command(args):
+    # type: (List[str]) -> Tuple[str, List[str]]
+    parser = create_main_parser()
+
+    # Note: parser calls disable_interspersed_args(), so the result of this
+    # call is to split the initial args into the general options before the
+    # subcommand and everything else.
+    # For example:
+    #  args: ['--timeout=5', 'install', '--user', 'INITools']
+    #  general_options: ['--timeout==5']
+    #  args_else: ['install', '--user', 'INITools']
+    general_options, args_else = parser.parse_args(args)
+
+    # --version
+    if general_options.version:
+        sys.stdout.write(parser.version)  # type: ignore
+        sys.stdout.write(os.linesep)
+        sys.exit()
+
+    # pip || pip help -> print_help()
+    if not args_else or (args_else[0] == 'help' and len(args_else) == 1):
+        parser.print_help()
+        sys.exit()
+
+    # the subcommand name
+    cmd_name = args_else[0]
+
+    if cmd_name not in commands_dict:
+        guess = get_similar_commands(cmd_name)
+
+        msg = ['unknown command "%s"' % cmd_name]
+        if guess:
+            msg.append('maybe you meant "%s"' % guess)
+
+        raise CommandError(' - '.join(msg))
+
+    # all the args without the subcommand
+    cmd_args = args[:]
+    cmd_args.remove(cmd_name)
+
+    return cmd_name, cmd_args