Module gcip.addons.python.scripts

Functions

def pip_install_requirements(*,
requirements_file: str = 'requirements.txt',
pipenv_version_specifier: str = '') ‑> str

Expand source code

def pip_install_requirements(
    *, requirements_file: str = "requirements.txt", pipenv_version_specifier: str = ""
) -> str:
    """
    Installs Python requirements from Pipfile.lock and requirements.txt.

    This function returns a bash command which does the following:

    * It checks if there is a Pipfile.lock
    * If so, it install pipenv and then installs requirements directly into the system with `pipenv install --system`.
    * The script then checks if there is a requirements file (`requirements.txt` by default).
    * If so, it installs it by running `pip install --upgrade -r <requirements_file>`.

    args:
        requirements_file: The location and name of the requirements file. Defaults to `requirements.txt`
        pipenv_version_specifier: The version hint of pipenv to install. For example '==2022.08.15'. Defaults
            to an empty string, which means the latest version will be installed.
    """
    return (
        f"if test -f Pipfile.lock; then pip install pipenv{pipenv_version_specifier}; pipenv install --dev --system; fi; "
        f"if test -f {requirements_file}; then pip install --upgrade -r {requirements_file}; fi"
    )

Installs Python requirements from Pipfile.lock and requirements.txt.

This function returns a bash command which does the following:

• It checks if there is a Pipfile.lock
• If so, it install pipenv and then installs requirements directly into the system with pipenv install --system.
• The script then checks if there is a requirements file (requirements.txt by default).
• If so, it installs it by running pip install --upgrade -r <requirements_file>.

args: requirements_file: The location and name of the requirements file. Defaults to requirements.txt pipenv_version_specifier: The version hint of pipenv to install. For example '==2022.08.15'. Defaults to an empty string, which means the latest version will be installed.