Help generating docker images from PDM projects
MIT License
Help generating docker image from PDM projects.
Install pdm-dockerize
:
pipx
If you installed pdm
with pipx
and want to have the command for all projects:
pipx inject pdm pdm-dockerize
pip
If you manually installed pdm
with pip
, just install the extra dependency in the same environment:
pip install pdm-dockerize
pdm
You can also install it as a standard pdm
plugin.
Either globally:
pdm self add pdm-dockerize
Either as a local plugin in your project:
[tool.pdm]
plugins = [
"pdm-dockerize",
]
Then:
pdm install --plugins
Just use pdm dockerize
in your multistage build:
# syntax=docker/dockerfile:1
ARG PY_VERSION=3.11
##
# Build stage: build and install dependencies
##
FROM python:${PY_VERSION} AS builder
ARG VERSION=0.dev
ENV PDM_BUILD_SCM_VERSION=${VERSION}
WORKDIR /project
# install PDM
RUN pip install -U pip setuptools wheel
RUN pip install pdm pdm-dockerize
RUN --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
--mount=type=bind,source=pdm.lock,target=pdm.lock \
--mount=type=cache,target=$HOME/.cache,uid=$UUID \
pdm dockerize --prod -v
##
# Run stage: create the final runtime container
##
FROM python:${PY_VERSION} AS runtime
WORKDIR /app
# Fetch built dependencies
COPY --from=builder /project/dist/docker /app
# Copy needed files from your project (filter using `.dockerignore`)
COPY . /app
ENTRYPOINT ["/app/entrypoint"]
CMD ["your-default-command"]
By default, the dockerize
command will render a script without any command as it does not select any script by default.
You can select scripts with the include
and exclude
properties of the tool.pdm.dockerize
section.
Those properties are optional, can be either a string or list of string.
Each string is a fnmatch
filter pattern
Dockerize first select script based on the include patterns and then filter-out those matching with any exclude pattern.
[tool.pdm.dockerize]
include = "*"
[tool.pdm.dockerize]
include = ["my-script", "my-other-script"]
prefix-*
[tool.pdm.dockerize]
include = "*"
exclude = "prefix-*"
[tool.pdm.dockerize]
include = "prefix-*"
exclude = ["prefix-not-you", "prefix-you-neither"]
By default, the dockerize
command will not copy any python executable provided by your dependencies.
You can select binaries with the include_bins
and exclude_bins
properties of the tool.pdm.dockerize
section.
Syntax and behavior are exactly the exact sames than include
/exclude
for script selection.
[tool.pdm.dockerize]
include_bins = "*"
Most of the time, you will look like this
[tool.pdm.dockerize]
include = ["uvicorn"]
pdm-dockerize
respects defined environment variables:
env
variables are properly set_.env
variables are properly setenv_file
are properly loaded_.env_file
are properly loadedIn addition, you can define some docker-only environment variables using the tool.pdm.dockerize.env
table
or some docker-only .env
files using tool.pdm.dockerize.env_file
Those environment variables will only be effective in the docker entrypoint.
[tool.pdm.dockerize.env]
VAR = "value"
This file will only be loaded in the docker entrypoint.
[tool.pdm.dockerize]
env_file = "docker.env"
This plugin works by providing by subclassing some pdm.installers
classes to reuse the installation process:
DockerizeInstallManager
, a pdm
InstallManager
filtering binariesDockerizeSynchronizer
, a pdm
Synchronizer
using a DockerizeInstallManager
as InstallManager
FilteringDestination
, a pdm
InstallDestination
filtering binariesThis way, the dockerization is using the same installation process just tuned for docker and augmented with pdm-dockerize
specifics.
Read the dedicated contributing guidelines.