---------------------------------------------------------------------- This is the API documentation for the gdtest_kitchen_sink library. ---------------------------------------------------------------------- ## Classes Core classes Pipeline(name: str) A data processing pipeline with many operations. Parameters ---------- name Pipeline name. Config(settings: dict | None = None) Configuration container for a pipeline. Parameters ---------- settings A dictionary of settings. ## Pipeline Methods Methods for the Pipeline class add_step(self, step) -> 'Pipeline' Add a processing step. Parameters ---------- step The step to add. Returns ------- Pipeline Self, for chaining. remove_step(self, index: int) -> 'Pipeline' Remove a step by index. Parameters ---------- index The step index to remove. Returns ------- Pipeline Self, for chaining. run(self) -> 'Result' Execute the pipeline. Returns ------- Result The pipeline result. validate(self) -> bool Check that the pipeline is correctly configured. Returns ------- bool True if valid. reset(self) -> None Clear all steps from the pipeline. summary(self) -> dict Return a summary of the pipeline. Returns ------- dict Summary with name, step count, etc. ## Dataclasses Data-holding classes Result(status: gdtest_kitchen_sink.Status, message: str = '', errors: list[str] = ) -> None The result of a pipeline execution. Parameters ---------- status Execution status. message Human-readable message. errors List of error strings, if any. ## Enumerations Enum types Status(*values) Pipeline execution status. ## Functions Public functions run_pipeline(name: str, **kwargs) -> gdtest_kitchen_sink.Result High-level function to create and run a pipeline. Parameters ---------- name Pipeline name. **kwargs Passed to Pipeline constructor. Returns ------- Result The execution result. validate_config(config: gdtest_kitchen_sink.Config) -> bool Validate a configuration object. Parameters ---------- config The config to validate. Returns ------- bool True if valid. format_output(result: gdtest_kitchen_sink.Result, fmt: str = 'text') -> str Format a result for display. Parameters ---------- result The result to format. fmt Output format (text, json, html). Returns ------- str Formatted output. parse_input(raw: str) -> dict Parse raw input into a structured dict. Parameters ---------- raw Raw input string. Returns ------- dict Parsed data. helper_a() -> None A general-purpose helper function. Returns ------- None helper_b() -> None Another general-purpose helper. Returns ------- None ---------------------------------------------------------------------- This is the User Guide documentation for the package. ---------------------------------------------------------------------- ### Introduction Welcome to Kitchen Sink! This is a comprehensive test package. ### Quick Start Get started with Kitchen Sink in minutes. ```python from gdtest_kitchen_sink import Pipeline p = Pipeline("my-pipeline") result = p.run() ``` ### Advanced Usage Advanced topics for power users.