PyBuilder Docker Build Plugin

Summary

This project is a plugin for PyBuilder that will perform a docker build for a Python package. PyBuilder Docker Build Plugin attempts to use sane defaults so that in most cases you only need add a Dockerfile to your project base directory and a docker image will be built when you call the appropriate task.

Usage

To use this plugin in your build.py file add the following line to the plugins section:

use_plugin('pypi:pybuilder_docker_build')

This will add the following tasks to your build:

The following properties are available:

By default there are several build args that are supplied to the docker build, additional args can be added with the docker_build_args property. The default build args are:

Authentication

If you need to push images to a registry then you probably need to set credentials. Don't do this directly in your build file but rather look them up from environment or use some other method for passing secrets to code. The following is an extract from the hello-world sample project in the samples directory:

@init
def set_properties(project: Project):
    project.set_property("docker_build_args", {"EXTRA_ARG": "Extra build arg"})
    project.set_property("docker_image_repo", "dockerhubusername/hello-world")
    # Don't put your credentials in code, look them up from environment or
    # use some other way to pass secrets to your code
    project.set_property(
        "docker_registry_auth",
        {
            "username": os.getenv("DOCKER_HUB_USERNAME"),
            "password": os.getenv("DOCKER_HUB_PASSWORD")
        }
    )