Home > API

---

Skelebot API

Version 1

---

• Common
• Objects
  • Component – The base object for Plugins to allow them to hook into the Skelebot Systems
  • SkeleYaml – The base object for any config Class that needs to be marshalled to/from YAML
• Execution
  • Docker – The Docker execution functions for building images and running containers
• Generators
  • YAML – The YAML generator for saving and loading config from skelebot.yaml
  • Dockerfile – The Dockerfile generator for constructing the project Dockerfile
  • Dockerignore – The dockerignore generator for constructing the project .dockerignore
• Scaffolding
  • Prompt – The function used to present prompts to the user for scaffolding purposes

---

Dockerfile Generator Module

The Dockerfile Generator provides the function for building the project Dockerfile based on the Config data so that the Project’s Docker Image can be constructed.

---

Import

from skelebot.systems.generators import dockerfile

buildDockerfile(config)

return None

PARAMETER	TYPE	DESCRIPTION
config	Config	The Config object representing the project configuration to be utilized in the Dockerfile

This function will utilize the data from the Config object to construct a fully functioning Dockerfile
for the project with dependencies installed.