host.intro.md

module host.intro

Introduction builder.

Global Variables

• ANSI_COLOR_NAMES

---

function show_all_colors

show_all_colors() → None

show_all_colors.

Args:

Returns: None:

---

function intro_load_pickle_b64

intro_load_pickle_b64(b64: str) → Intro

intro_load_pickle_b64.

Args:

• b64 (str): b64

Returns:

• Intro: intro object

---

function intro_export_b64

intro_export_b64(intro: Intro) → str

intro_export_b64.

Args:

• intro (Intro): intro

Returns:

• str: exported b64 encoded intro object

---

class Intro

Intro.

method __init__

__init__(title: str, template_path: Path, config: Dict)

init.

Args:

• title (str): title
• template_path (Path): template_path
• config (Dict): config

---

property console

console.

Args:

Returns: Console:

---

property title

title.

Args:

Returns: str:

---

method PADDING

PADDING(el: Any) → Padding

PADDING.

Args:

• el (Any): el

Returns:

• Padding: pad object

---

method code

code(code_dct: Dict) → None

code.

Args:

• code_dct (Dict): code_dct

---

method get_code

get_code(code_dct: Dict) → Syntax

get_code.

Args:

• code_dct (Dict): code_dct

Returns:

• Syntax: code syntax object syntax

---

method header

header(header_txt: str) → None

header.

Args:

• header_txt (str): header_txt

---

method j2

j2(filename: str) → None

j2.

Args:

• filename (str): filename

---

method load

load(datafile: Path, values: List[Dict[str, str]]) → None

load.

Args:

• datafile (Path): datafile
• values (List[Dict[str, str]]): values

Raises:

• PreCheckFail: if validation fails

---

method run

run() → None

run.

---

method table

table(dct: Dict) → None

table.

Args:

• dct (Dict): dct

Returns: None:

---

method txt

txt(text: str) → None

txt.

Args:

• text (str): text

---

This file was automatically generated via lazydocs.