vibesketch.document.template_library

Offline compounds, open-attachment fragments and the full named-reaction index.

Functions

get_template(identifier)

insert_template(document, identifier, *[, ...])

Append a separate editable block, preserving the document and existing chemistry.

list_templates([query, category, kind])

Search names, aliases, formulae and categories; optional exact category/kind filters.

template_fragment(identifier, *[, scaffold])

Return editable KET; incomplete reactions require explicit scaffold selection.

Classes

TemplateEntry(*, id, name, aliases, category)

class vibesketch.document.template_library.TemplateEntry(*, id, name, aliases, category, tags=(), kind, sources, note, smiles=None, formula=None, attachment_points=0, scope='chemical')[source]

Bases: BaseModel

Parameters:
model_config = {'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

id: str
name: str
aliases: tuple[str, ...]
category: str
tags: tuple[str, ...]
kind: TemplateKind
sources: tuple[ReactionSource, ...]
note: str
smiles: str | None
formula: str | None
attachment_points: int
scope: str
vibesketch.document.template_library.list_templates(query='', *, category='', kind='')[source]

Search names, aliases, formulae and categories; optional exact category/kind filters.

Parameters:
Return type:

list[TemplateEntry]

vibesketch.document.template_library.get_template(identifier)[source]
Parameters:

identifier (str)

Return type:

TemplateEntry

vibesketch.document.template_library.template_fragment(identifier, *, scaffold=False)[source]

Return editable KET; incomplete reactions require explicit scaffold selection.

Parameters:
Return type:

dict[str, Any]

vibesketch.document.template_library.insert_template(document, identifier, *, scaffold=False)[source]

Append a separate editable block, preserving the document and existing chemistry.

Parameters:
Return type:

Derivation