Metadata-Version: 2.1
Name: pybuilder-docker-build
Version: 0.3.0
Summary: A Docker build plugin for PyBuilder
Home-page: https://github.com/jlsheehan/pybuilder-docker-build
Author: Jeffrey Sheehan
Author-email: jeff.sheehan7@gmail.com
Maintainer: 
Maintainer-email: 
License: MIT License
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown

PyBuilder Docker Build Plugin
=============================

Summary
-------

This project is a plugin for [PyBuilder](https://pybuilder.io) 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:

```python
use_plugin('pypi:pybuilder_docker_build')
```

This will add the following tasks to your build:

| Task         | Description                               |
|--------------|-------------------------------------------|
| docker_build | Performs docker build                     |
| docker_save  | Saves docker image to dist dir            |
| docker_push  | Pushes docker image upstream to your repo |

The following properties are available:

| Property              | Value        | Default            | Usage                                                               |
|-----------------------|--------------|--------------------|---------------------------------------------------------------------|
| docker_cli            | True / False | False              | Use docker cli to do build                                          |
| docker_path           | str          | docker             | Path to docker executable                                           |
| docker_build_path     | str          | `basedir` property | Path to docker build directory                                      |
| docker_build_file     | str          | Dockerfile         | Dockerfile to use for build, relative path from `docker_build_path` |
| docker_build_force_rm | True / False | False              | Use the force rm feature of docker build                            |
| docker_image_repo     | str          | `project.name`     | The name of the image repository                                    |
| docker_image_tag      | str          | latest             | A tag to apply to the repository                                    |
| docker_build_args     | dict         | None               | A dict of build args                                                |

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:

| Argument             | Value                                                                  |
|----------------------|------------------------------------------------------------------------|
| PROJECT_NAME         | `project.name`                                                         |
| PROJECT_VERSION      | `project.version`                                                      |
| PROJECT_DIST_VERSION | `project.dist_version`                                                 |
| PROJECT_DIST         | The relative path from the `docker_build_path` property to `$dir_dist` |


