Python API¶
Homer Python API autodoc.
Homer package.
-
class
homer.
Homer
(main_config: Mapping)[source]¶ Bases:
object
The instance to run Homer.
Initialize the instance.
- Parameters
main_config (dict) -- the configuration dictionary.
-
commit
(query: str, *, message: str = '-') → int[source]¶ Commit the generated configuration asking for confirmation.
-
diff
(query: str, *, omit_diff: bool = False) → int[source]¶ Generate the configuration and check the diff with the current live one.
-
homer.
DIFF_EXIT_CODE
= 99¶ the exit code used when the diff command is executed and there is a diff.
- Type
Subpackages and Submodules