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

---

Dockerignore Generator Module

The Dockerignore Generator provides the function for building the project .dockerignore based on the Config data so that only required files and folders are included in the Docker build process.

---

Import

from skelebot.systems.generators import dockerignore

buildDockerignore(config)

return None

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

This function will utilize the ignores list from the Config object to construct a fully functioning
.dockerignore file for the project in order to omit specific files and folders and reduce the
amount of data inside the build context during the Docker build process.