Home > API

---

Skelebot API

Version 2

---

• 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

---

Common Module

Import

import skelebot.common

The common module holds several constant values that are applicable to all aspects of Skelebot.

Constants

NAME	VALUE	DESCRIPTION
SKELEBOT_HOME	”~/.skelebot”	Skelebot’s home directory
PLUGINS_HOME	”~/.skelebot/plugins”	Plugin folder home directory

---