gnomish_army_knife.macro package

Contents

gnomish_army_knife.macro package#

Submodules#

gnomish_army_knife.macro.category module#

A module implementing an interface for macro categories.

class gnomish_army_knife.macro.category.MacroCategory(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = None, schemas: SchemaMap = None, dest_attr: str = 'data', verify: bool = True)[source]#

Bases: BasicGakCodec

A class implementing an interface for macros.

init(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]]) → None[source]#: Perform implementation-specific initialization.

write_markdown_dir(path: Path, name: str = 'index.md') → None[source]#: Write markdown contents to disk.

gnomish_army_knife.macro.database module#

A module implementing a macro database structure.

class gnomish_army_knife.macro.database.MacroDatabase(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = None, schemas: SchemaMap = None, dest_attr: str = 'data', verify: bool = True)[source]#

Bases: BasicGakCodec

A class implementing an interface for macros.

init(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]]) → None[source]#: Perform implementation-specific initialization.

static load(path: Path | str = 'package://gnomish_army_knife/macros.yaml') → MacroDatabase[source]#: Load a macro database from disk.

write_markdown_dir(path: Path, name: str = 'index.md') → None[source]#: Write markdown contents to disk.

gnomish_army_knife.macro.group module#

A module implementing an interface for macro groups.

class gnomish_army_knife.macro.group.MacroGroup(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = None, schemas: SchemaMap = None, dest_attr: str = 'data', verify: bool = True)[source]#

Bases: BasicGakCodec

A class implementing an interface for macros.

init(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]]) → None[source]#: Perform implementation-specific initialization.

write_markdown(parent_name: str, parent_icon_url: str, path: Path) → None[source]#: Write markdown contents to disk.

Module contents#

A module implementing macro interfaces.

class gnomish_army_knife.macro.Macro(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = None, schemas: SchemaMap = None, dest_attr: str = 'data', verify: bool = True)[source]#

Bases: GakDictCodec, BasicDictCodec

A class implementing an interface for macros.

init(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]]) → None[source]#: Perform implementation-specific initialization.

short_markdown: str#