Class Generator

openkb/skill/generator.py:46–125

A v0.3 generator instance. Args: target_type: ``"skill"`` or ``"deck"``. name: kebab-case slug; becomes the output directory name. intent: natural-language description of the desired artifact. kb_dir: KB root. model: LiteLLM model name (from KB config).

class Generator:
    """A v0.3 generator instance.

    Args:
        target_type: ``"skill"`` or ``"deck"``.
        name: kebab-case slug; becomes the output directory name.
        intent: natural-language description of the desired artifact.
        kb_dir: KB root.
        model: LiteLLM model name (from KB config).
        critique: (deck only) opt-in second-pass via the
            ``openkb-html-critic`` skill which patches the produced HTML
            in place. Ignored for ``target_type="skill"``.
    """

    def __init__(
        self,
        *,
        target_type: TargetType,
        name: str,
        intent: str,
        kb_dir: Path,
        model: str,
        critique: bool = False,
        skill_name: str | None = None,
    ) -> None:
        """Args:
        skill_name: For ``target_type="deck"``, which deck skill to use.
            Defaults to :data:`openkb.deck.creator.DEFAULT_DECK_SKILL`
            (``"openkb-deck-neon"``). Ignored for skill target.
        """
        if target_type not in ("skill", "deck"):
            raise ValueError(
                f"Unknown target_type {target_type!r}. v0.3 supports 'skill' and 'deck'."
            )
        self.target_type: TargetType = target_type
        self.name = name
        self.intent = intent
        self.kb_dir = kb_dir
        self.model = model
        self.critique = critique
        self.skill_name = skill_name or DEFAULT_DECK_SKILL
        self.output_dir = (
            deck_dir(kb_dir, name) if target_type == "deck" else skill_dir(kb_dir, name)
        )
        self.validation: AnyValidationResult | None = None

    async def run(self) -> Path:
        """Execute the generator. Returns the path to the produced artifact.

        Side-effects, in order: compile → validate → (skill only) publish
        manifest. ``self.validation`` holds the result so callers can
        surface issues without re-running the validator. For deck target,
        validation runs inside ``run_skill`` via the producing skill's
        frontmatter-declared grammar; we propagate it up.
        """
        if self.target_type == "skill":
            await run_skill_create(
                kb_dir=self.kb_dir,