Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use a Python virtual environment #190

Merged
merged 3 commits into from
Feb 27, 2024
Merged

Use a Python virtual environment #190

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8534e1d
Prefer calling pip as a module
mcdonnnj Feb 26, 2024
8113726
Use a Python virtual environment in the Docker image
mcdonnnj Feb 26, 2024
77b5e34
Explain `ln` options being used
mcdonnnj Feb 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 19 additions & 11 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ ARG CISA_GID=${CISA_UID}
ARG CISA_USER="cisa"
ENV CISA_GROUP=${CISA_USER}
ENV CISA_HOME="/home/${CISA_USER}"
ENV VIRTUAL_ENV="${CISA_HOME}/.venv"

# Versions of the Python packages installed directly
ENV PYTHON_PIP_VERSION=24.0
Expand All @@ -42,25 +43,32 @@ RUN addgroup --system --gid ${CISA_GID} ${CISA_GROUP} \
&& adduser --system --uid ${CISA_UID} --ingroup ${CISA_GROUP} ${CISA_USER}

###
# Make sure the specified versions of pip, setuptools, and wheel are installed
# Set up a Python virtual environment (venv); install the specified versions of pip,
# setuptools, and wheel into it; and then install the Python dependencies for
# the application.
#
# Note that we use pip3 --no-cache-dir to avoid writing to a local
# Note that we use the --no-cache-dir flag to avoid writing to a local
# cache. This results in a smaller final image, at the cost of
# slightly longer install times.
###
RUN pip3 install --no-cache-dir --upgrade \
pip==${PYTHON_PIP_VERSION} \
setuptools==${PYTHON_SETUPTOOLS_VERSION} \
wheel==${PYTHON_WHEEL_VERSION}
RUN python3 -m venv ${VIRTUAL_ENV} \
&& ${VIRTUAL_ENV}/bin/python3 -m pip install --no-cache-dir --upgrade \
pip==${PYTHON_PIP_VERSION} \
setuptools==${PYTHON_SETUPTOOLS_VERSION} \
wheel==${PYTHON_WHEEL_VERSION} \
&& ${VIRTUAL_ENV}/bin/python3 -m pip install --no-cache-dir --upgrade \
https://github.com/cisagov/skeleton-python-library/archive/v${VERSION}.tar.gz

###
# Install Python dependencies
# Sym-link the Python binary in the venv to the system-wide Python and add the venv to
# the PATH.
#
# Note that we use pip3 --no-cache-dir to avoid writing to a local
# cache. This results in a smaller final image, at the cost of
# slightly longer install times.
# Note that we sym-link the Python binary in the venv to the system-wide Python so that
# any calls to `python3` will use our virtual environment. We are using short flags
# because the ln binary in Alpine Linux does not support long flags.
###
RUN pip3 install --no-cache-dir https://github.com/cisagov/skeleton-python-library/archive/v${VERSION}.tar.gz
RUN ln -sf "$(command -v python3)" "${VIRTUAL_ENV}"/bin/python3
jsf9k marked this conversation as resolved.
Show resolved Hide resolved
ENV PATH="${VIRTUAL_ENV}/bin:$PATH"

###
# Prepare to run
Expand Down
Loading