Module

`readme`

Kida README generator — auto-detect project metadata, render styled READMEs.

Functions

detect_project 2 ProjectContext ▼

Auto-detect project metadata from a directory. Convenience re-export of `detec…

def detect_project(root: Path, *, depth: int = 2) -> ProjectContext

Auto-detect project metadata from a directory.

Convenience re-export ofdetect_project().

Parameters

Name	Type	Description
`root`	`Path`
`depth`	`int`	Default:`2`

Returns

ProjectContext

render_readme 5 str ▼

Auto-detect project metadata and render a README.

def render_readme(root: Path, *, preset: str = 'default', template: Path | None = None, context: dict[str, Any] | ProjectContext | None = None, depth: int = 2) -> str

Parameters

Name	Type	Description
`root`	`Path`	Project root directory to scan.
`preset`	`str`	Built-in template preset (`"default"`, `"minimal"`, `"library"`, `"cli"`). Default:`'default'`
`template`	`Path \| None`	Path to a custom template file (overrides preset). Default:`None`
`context`	`dict[str, Any] \| ProjectContext \| None`	Extra context variables that override auto-detected values. Default:`None`
`depth`	`int`	Directory tree depth for auto-detection (default 2). Default:`2`

Returns

str