Docker Interface (DI) is a declarative interface for building images and running commands in containers using Docker.

You can install Docker Interface using the following pip command (you need a python3 interpreter).

pip install docker-interface

To check that Docker Interface was installed successfully, run

di --help

Docker Interface can be invoked from the command line. By default, it reads the configuration from the file di.yml in the current working directory and supports two commands:

• build builds a Docker image according to the configuration
• run runs a Docker command in a container

You can find specific examples in the examples folder in this repository. See https://docker-interface.readthedocs.io/en/latest/ for more detailed documentation, and check the schema to get a comprehensive overview of the declarative syntax supported by Docker Interface.

To contribute to the development of Docker Interface, please create a fork of the repository and send any changes as a pull request.

You can test your local installation of Docker Interface as follows.

# 0. Set up a virtual environment (optional but recommended)
# 1. Install development requirements
pip install -r requirements.txt
# 2. Install docker interface in editable mode
pip install -e .
# Run the tests
make tests

See virtualenv or conda for details on how to set up a virtual environment in step 0.

This project adheres to the Open Code of Conduct. By participating, you are expected to honour this code.