Functions

The top-level entry points. Everything here is importable directly from denckring.

denckring.check

check(
    procedure_id: str,
    text: str,
    *,
    lang: Lang = "en",
    **params: Any,
) -> Report

Check a text against a procedure by id.

denckring.get

get(procedure_id: str) -> BaseProcedure[Any]

One registered procedure, or UnknownProcedure.

denckring.describe

describe(
    procedure_id: str,
    *,
    lang: Lang = "en",
    scholarly: bool = False,
) -> Description

One procedure, in full. Raises UnknownProcedure for an unknown id.

denckring.summaries

summaries(
    *,
    query: str | None = None,
    family: str | None = None,
    runnable_only: bool = False,
    lang: Lang = "en",
) -> list[Summary]

The implemented procedures, filtered. query subsumes search.

Only implemented rows appear: the other 66 catalogued forms have no checker, so offering them would be offering something that cannot run.

denckring.list_procedures

list_procedures() -> list[str]

Every registered procedure id, sorted.

denckring.all_procedures

all_procedures() -> dict[str, BaseProcedure[Any]]

Every registered procedure, by id.