Skip to content

Python API

These pages discover modules from the source tree at build time and render their docstrings and type annotations with mkdocstrings, so new domain modules, ports, and services appear without editing the docs navigation or a handwritten symbol list. They document the stable internal seams of Refindery for contributors and for anyone embedding Refindery as a library.

Generated statically

The Python handler analyzes the source with griffe — it does not import the modules — so rendering the reference never triggers the optional heavy dependencies (torch, gliner, …) that Refindery imports lazily.

Layout

Page Module(s) What it covers
Configuration refindery.config Settings and every nested settings group.
Domain models refindery.domain.* Models, identifiers, URL logic, retrieval and ranking algorithms.
Ports refindery.application.ports.* The Protocol contracts every adapter implements.
Services refindery.application.services.* The use-case orchestration layer.

For the architectural picture these types live inside — the hexagonal layering, the composition root, and the data flow — start with the Architecture overview.