poetry-dockerize-plugin 1.3.1

Poetry application to Docker, automatically.

Poetry Dockerize Plugin

Key features:

• Automatically generate a docker image from your Poetry application.
• Highly configurable. You can configure the image by adding a section in the pyproject.toml configuration file.

Installation

In order to install the plugin you need to have installed a poetry version >=1.2.0 and type:

poetry self add poetry-dockerize-plugin@latest

Quickstart

No configuration needed! Just type:

poetry dockerize
>Building image: poetry-sample-app:latest
>Successfully built image: poetry-sample-app:latest
docker run --rm -it poetry-sample-app:latest
>hello world!

Usage in GitHub Actions

You just need to run the quickstart command in your GitHub Actions workflow:

name: Build and publish latest

on:
  push:
    branches: main

jobs:
  login:
    runs-on: ubuntu-latest
    steps:
        - name: Install Poetry
          uses: snok/install-poetry@v1

        - name: Install poetry-dockerize-plugin
          run: poetry self add poetry-dockerize-plugin@latest

        - name: Build and package
          run: |
            poetry install
            poetry run pytest
            poetry dockerize

        - name: Login to Docker Hub
          uses: docker/login-action@v3
          with:
            username: ${{ secrets.DOCKERHUB_USERNAME }}
            password: ${{ secrets.DOCKERHUB_TOKEN }}

        - name: Push to Docker Hub
          run: docker push my-app:latest

Configuration via pyproject.toml

To customize some options, you can add a [tool.dockerize] section in your pyproject.toml file. For example to change the image name:

[tool.dockerize]
name = "myself/myproject-app"

Configuration via environment variables

You can also pass any option via environment variable by prefixing the key with DOCKERIZE_. For example, to set the entrypoint you can use the DOCKERIZE_ENTRYPOINT environment variable:

export DOCKERIZE_ENTRYPOINT="python -m myapp"
poetry dockerize

or use a .env file which will be loaded by the plugin:

echo "DOCKERIZE_ENTRYPOINT=python -m myapp" > .env
poetry dockerize

For dicts such as env and labels, you can set multiple values by adding multiple variables:

export DOCKERIZE_ENV_MY_VAR="my_value"
export DOCKERIZE_ENV_MY_OTHER_VAR="my_other_value"
export DOCKERIZE_LABELS_MY_LABEL="label1"
poetry dockerize

Configuration API Reference

This examples shows a complete configuration of the docker image:

[tool.dockerize]
name = "alternative-image-name"
python = "3.12"
base-image = "python:3.12-slim"
tags = ["latest-dev"]
entrypoint = ["python", "-m", "whatever"]
ports = [5000]
env = {"MY_APP_ENV" = "dev"}
labels = {"MY_APP_LABEL" = "dev"}
apt-packages = ["curl"]
extra-run-instructions = ["RUN curl https://huggingface.co/transformers/"]

# Only for build docker layer
build-apt-packages = ["gcc"]
extra-build-instructions = ["RUN poetry config http-basic.foo <username> <password>"]
build-poetry-install-args = ["-E", "all", "--no-root"]

• name customizes the docker image name.
• python python version to use. If not specified, will try to be extracted from tool.poetry.dependencies.python. Default is 3.11
• base-image customizes the base image. If not defined, the default base image is python:<python-version>-slim-bookworm.
• tags declares a list of tags for the image.
• entrypoint customizes the entrypoint of the image. If not provided, the default entrypoint is retrieved from the packages configuration.
• ports exposes ports
• env declares environment variables inside the docker image.
• labels append labels to the docker image. Default labels are added following the opencontainers specification.
• apt-packages installs apt packages inside the docker image.
• extra-run-instructions adds extra instructions to the docker run (after poetry install). Any modification to the filesystem will be kept after the poetry install.

For the build step:

• build-apt-packages installs apt packages inside the build docker container.
• extra-build-instructions adds extra instructions to the docker build (before poetry install). Any modification to the filesystem will be lost after the poetry install. If you need to add files to the image, use the extra-run-instructions.
• build-poetry-install-args adds additional arguments to the poetry install command in the build step.

Command line options

All command line options provided by the poetry-dockerize-plugin may be accessed by typing:

poetry dockerize --help

Troubleshooting

To troubleshoot the plugin, you can use the --debug flag to get more information about the execution.

poetry dockerize --debug

Generate Dockerfile

To only generate the Dockerfile, you can use the --generate flag.

poetry dockerize --generate

Then you can store the Dockerfile on the repository and use it as a template and customize it as you need.

License

This project is licensed under the terms of the MIT license.