etlplus 0.16.2__tar.gz → 0.16.4__tar.gz

{etlplus-0.16.2 → etlplus-0.16.4}/CONTRIBUTING.md

@@ -133,5 +133,5 @@ If a test calls `etlplus.cli.main()` or `etlplus.ops.run.run()`, it is integrati
 - CLI tests: monkeypatch `sys.argv` and call `etlplus.cli.main()`; capture output with `capsys`.
 - File I/O: use `tmp_path` / `TemporaryDirectory()`; never write to the repo tree.
 - API flows: stub `EndpointClient` or transport layer via `monkeypatch` to avoid real HTTP.
-- Runner tests: monkeypatch `load_pipeline_config` to inject an in-memory `PipelineConfig`.
+- Runner tests: monkeypatch `load_config` to inject an in-memory `Config`.
 - Keep tests small and focused; prefer one behavior per test with clear assertions.

{etlplus-0.16.2/etlplus.egg-info → etlplus-0.16.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etlplus
-Version: 0.16.2
+Version: 0.16.4
 Summary: A Swiss Army knife for simple ETL operations
 Home-page: https://github.com/Dagitali/ETLPlus
 Author: ETLPlus Team

{etlplus-0.16.2 → etlplus-0.16.4}/docs/pipeline-guide.md

@@ -497,8 +497,8 @@ For the HTTP client and pagination API, see `etlplus/api/README.md`.
 
 ## Design notes: Mapping inputs, dict outputs
 
-ETLPlus config constructors (e.g., `ApiConfig.from_obj`, `PipelineConfig.from_dict`) accept
-`Mapping[str, Any]` rather than `dict[str, Any]` for inputs. Why?
+ETLPlus config constructors (e.g., `ApiConfig.from_obj`, `Config.from_dict`) accept `Mapping[str,
+Any]` rather than `dict[str, Any]` for inputs. Why?
 
 - Flexibility: callers can pass any mapping-like object (e.g., YAML loaders that return custom
   mappings) without copying into a `dict` first.

{etlplus-0.16.2 → etlplus-0.16.4}/etlplus/README.md

@@ -31,6 +31,28 @@ assert validate(filtered, {"age": {"type": "number", "min": 0}})["valid"]
 load(filtered, "file", "output.json", file_format="json")
 ```
 
+## Loading and Validating Configs
+
+Use the provided classes to load and validate configuration files:
+
+```python
+from etlplus.workflow import Config
+
+cfg = Config.from_yaml("pipeline.yml")
+```
+
+- Supports YAML and JSON formats
+- Validates against expected schema
+
+## Example: Loading a Pipeline Config
+
+```python
+from etlplus.workflow import Config
+
+config = Config.from_yaml("configs/pipeline.yml")
+print(config)
+```
+
 ## See Also
 
 - [Top-level project README](../README.md)

{etlplus-0.16.2 → etlplus-0.16.4}/etlplus/__init__.py

@@ -5,6 +5,7 @@ Top-level facade for the ETLPlus toolkit.
 """
 
 from .__version__ import __version__
+from .config import Config
 
 __author__ = 'ETLPlus Team'
 
@@ -15,4 +16,5 @@ __author__ = 'ETLPlus Team'
 __all__ = [
     '__author__',
     '__version__',
+    'Config',
 ]

{etlplus-0.16.2 → etlplus-0.16.4}/etlplus/cli/commands.py

@@ -62,6 +62,16 @@ __all__ = ['app']
 # SECTION: TYPE ALIASES ==================================================== #
 
 
+ConfigOption = Annotated[
+    str,
+    typer.Option(
+        ...,
+        '--config',
+        metavar='PATH',
+        help='Path to YAML-formatted configuration file.',
+    ),
+]
+
 JobOption = Annotated[
     str | None,
     typer.Option(
@@ -97,16 +107,6 @@ OutputOption = Annotated[
     ),
 ]
 
-PipelineConfigOption = Annotated[
-    str,
-    typer.Option(
-        ...,
-        '--config',
-        metavar='PATH',
-        help='Path to pipeline YAML configuration file.',
-    ),
-]
-
 PipelineOption = Annotated[
     str | None,
     typer.Option(
@@ -407,7 +407,7 @@ def _root(
 @app.command('check')
 def check_cmd(
     ctx: typer.Context,
-    config: PipelineConfigOption,
+    config: ConfigOption,
     jobs: JobsOption = False,
     pipelines: PipelinesOption = False,
     sources: SourcesOption = False,
@@ -422,20 +422,20 @@ def check_cmd(
     ----------
     ctx : typer.Context
         The Typer context.
-    config : PipelineConfigOption
+    config : ConfigOption
         Path to pipeline YAML configuration file.
-    jobs : bool, optional
+    jobs : JobsOption, optional
         List available job names and exit. Default is ``False``.
-    pipelines : bool, optional
+    pipelines : PipelinesOption, optional
         List ETL pipelines. Default is ``False``.
-    sources : bool, optional
+    sources : SourcesOption, optional
         List data sources. Default is ``False``.
-    summary : bool, optional
+    summary : SummaryOption, optional
         Show pipeline summary (name, version, sources, targets, jobs). Default
         is ``False``.
-    targets : bool, optional
+    targets : TargetsOption, optional
         List data targets. Default is ``False``.
-    transforms : bool, optional
+    transforms : TransformsOption, optional
         List data transforms. Default is ``False``.
 
     Returns
@@ -725,7 +725,7 @@ def render_cmd(
 @app.command('run')
 def run_cmd(
     ctx: typer.Context,
-    config: PipelineConfigOption,
+    config: ConfigOption,
     job: JobOption = None,
     pipeline: PipelineOption = None,
 ) -> int:
@@ -736,11 +736,11 @@ def run_cmd(
     ----------
     ctx : typer.Context
         The Typer context.
-    config : PipelineConfigOption
+    config : ConfigOption
         Path to pipeline YAML configuration file.
-    job : str | None, optional
+    job : JobOption, optional
         Name of the job to run. Default is ``None``.
-    pipeline : str | None, optional
+    pipeline : PipelineOption, optional
         Name of the pipeline to run. Default is ``None``.
 
     Returns

{etlplus-0.16.2 → etlplus-0.16.4}/etlplus/cli/handlers.py

@@ -14,6 +14,7 @@ from typing import Any
 from typing import Literal
 from typing import cast
 
+from .. import Config
 from ..database import load_table_spec
 from ..database import render_tables
 from ..file import File
@@ -26,8 +27,6 @@ from ..ops import validate
 from ..ops.validate import FieldRules
 from ..types import JSONData
 from ..types import TemplateKey
-from ..workflow import PipelineConfig
-from ..workflow import load_pipeline_config
 from . import io as cli_io
 
 # SECTION: EXPORTS ========================================================== #
@@ -73,14 +72,14 @@ def _collect_table_specs(
         specs.append(dict(load_table_spec(Path(spec_path))))
 
     if config_path:
-        cfg = load_pipeline_config(config_path, substitute=True)
+        cfg = Config.from_yaml(config_path, substitute=True)
         specs.extend(getattr(cfg, 'table_schemas', []))
 
     return specs
 
 
 def _check_sections(
-    cfg: PipelineConfig,
+    cfg: Config,
     *,
     jobs: bool,
     pipelines: bool,
@@ -93,7 +92,7 @@ def _check_sections(
 
     Parameters
     ----------
-    cfg : PipelineConfig
+    cfg : Config
         The loaded pipeline configuration.
     jobs : bool
         Whether to include job metadata.
@@ -133,14 +132,14 @@ def _check_sections(
 
 
 def _pipeline_summary(
-    cfg: PipelineConfig,
+    cfg: Config,
 ) -> dict[str, Any]:
     """
     Return a human-friendly snapshot of a pipeline config.
 
     Parameters
     ----------
-    cfg : PipelineConfig
+    cfg : Config
         The loaded pipeline configuration.
 
     Returns
@@ -229,7 +228,7 @@ def check_handler(
         Zero on success.
 
     """
-    cfg = load_pipeline_config(config, substitute=substitute)
+    cfg = Config.from_yaml(config, substitute=substitute)
     if summary:
         cli_io.emit_json(_pipeline_summary(cfg), pretty=True)
         return 0
@@ -514,7 +513,7 @@ def run_handler(
     int
         Zero on success.
     """
-    cfg = load_pipeline_config(config, substitute=True)
+    cfg = Config.from_yaml(config, substitute=True)
 
     job_name = job or pipeline
     if job_name:

etlplus-0.16.2/etlplus/workflow/pipeline.py → etlplus-0.16.4/etlplus/config.py

@@ -1,7 +1,7 @@
 """
-:mod:`etlplus.workflow.pipeline` module.
+:mod:`etlplus.config` module.
 
-Pipeline configuration model and helpers for job orchestration.
+Configuration model and helpers for job pipeline orchestration.
 
 Notes
 -----
@@ -24,26 +24,24 @@ from pathlib import Path
 from typing import Any
 from typing import Self
 
-from ..api import ApiConfig
-from ..connector import Connector
-from ..connector import parse_connector
-from ..file import File
-from ..file import FileFormat
-from ..types import StrAnyMap
-from ..utils import coerce_dict
-from ..utils import deep_substitute
-from ..utils import maybe_mapping
-from .jobs import JobConfig
-from .profile import ProfileConfig
+from .api import ApiConfig
+from .connector import Connector
+from .connector import parse_connector
+from .file import File
+from .file import FileFormat
+from .types import StrAnyMap
+from .utils import coerce_dict
+from .utils import deep_substitute
+from .utils import maybe_mapping
+from .workflow.jobs import JobConfig
+from .workflow.profile import ProfileConfig
 
 # SECTION: EXPORTS ========================================================== #
 
 
 __all__ = [
     # Data Classes
-    'PipelineConfig',
-    # Functions
-    'load_pipeline_config',
+    'Config',
 ]
 
 
@@ -126,29 +124,11 @@ def _parse_connector_entry(
         return None
 
 
-# SECTION: FUNCTIONS ======================================================== #
-
-
-def load_pipeline_config(
-    path: Path | str,
-    *,
-    substitute: bool = False,
-    env: Mapping[str, str] | None = None,
-) -> PipelineConfig:
-    """
-    Load a pipeline YAML file into a ``PipelineConfig`` instance.
-
-    Delegates to ``PipelineConfig.from_yaml`` for construction and optional
-    variable substitution.
-    """
-    return PipelineConfig.from_yaml(path, substitute=substitute, env=env)
-
-
 # SECTION: DATA CLASSES ===================================================== #
 
 
 @dataclass(kw_only=True, slots=True)
-class PipelineConfig:
+class Config:
     """
     Configuration for the data processing pipeline.
 
@@ -211,7 +191,7 @@ class PipelineConfig:
         env: Mapping[str, str] | None = None,
     ) -> Self:
         """
-        Parse a YAML file into a ``PipelineConfig`` instance.
+        Parse a YAML file into a ``Config`` instance.
 
         Parameters
         ----------
@@ -259,7 +239,7 @@ class PipelineConfig:
         raw: StrAnyMap,
     ) -> Self:
         """
-        Parse a mapping into a ``PipelineConfig`` instance.
+        Parse a mapping into a ``Config`` instance.
 
         Parameters
         ----------

etlplus-0.16.4/etlplus/enums.py

@@ -0,0 +1,144 @@
+"""
+:mod:`etlplus.enums` module.
+
+Shared enumeration base class.
+"""
+
+from __future__ import annotations
+
+import enum
+from typing import Self
+
+from .types import StrStrMap
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    # Enums
+    'CoercibleStrEnum',
+]
+
+
+# SECTION: CLASSES ========================================================== #
+
+
+class CoercibleStrEnum(enum.StrEnum):
+    """
+    StrEnum with ergonomic helpers.
+
+    Provides a DRY, class-level :meth:`coerce` that normalizes inputs and
+    produces consistent, informative error messages. Also exposes
+    :meth:`choices` for UI/validation and :meth:`try_coerce` for soft parsing.
+
+    Notes
+    -----
+    - Values are normalized via ``str(value).strip().casefold()``.
+    - If value matching fails, the raw string is tried as a member name.
+    - Error messages enumerate allowed values for easier debugging.
+    """
+
+    # -- Class Methods -- #
+
+    @classmethod
+    def aliases(cls) -> StrStrMap:
+        """
+        Return a mapping of common aliases for each enum member.
+
+        Subclasses may override this method to provide custom aliases.
+
+        Returns
+        -------
+        StrStrMap
+            A mapping of alias strings to their corresponding enum member
+            values or names.
+
+        Notes
+        -----
+        - Alias keys are normalized via ``str(key).strip().casefold()``.
+        - Alias values should be member values or member names.
+        """
+        return {}
+
+    @classmethod
+    def choices(cls) -> tuple[str, ...]:
+        """
+        Return the allowed string values for this enum.
+
+        Returns
+        -------
+        tuple[str, ...]
+            A tuple of allowed string values for this enum.
+        """
+        return tuple(member.value for member in cls)
+
+    @classmethod
+    def coerce(cls, value: Self | str | object) -> Self:
+        """
+        Convert an enum member or string-like input to a member of *cls*.
+
+        Parameters
+        ----------
+        value : Self | str | object
+            An existing enum member or a string-like value to normalize.
+
+        Returns
+        -------
+        Self
+            The corresponding enum member.
+
+        Raises
+        ------
+        ValueError
+            If the value cannot be coerced into a valid member.
+        """
+        if isinstance(value, cls):
+            return value
+        try:
+            raw = str(value).strip()
+            normalized = raw.casefold()
+            aliases = {
+                str(key).strip().casefold(): alias
+                for key, alias in cls.aliases().items()
+            }
+            resolved = aliases.get(normalized)
+            if resolved is None:
+                try:
+                    return cls(normalized)  # type: ignore[arg-type]
+                except (ValueError, TypeError):
+                    return cls[raw]  # type: ignore[index]
+            if isinstance(resolved, cls):
+                return resolved
+            try:
+                return cls(resolved)  # type: ignore[arg-type]
+            except (ValueError, TypeError):
+                # Allow aliases to reference member names.
+                return cls[resolved]  # type: ignore[index]
+        except (ValueError, TypeError, KeyError) as e:
+            allowed = ', '.join(cls.choices())
+            raise ValueError(
+                f'Invalid {cls.__name__} value: {value!r}. Allowed: {allowed}',
+            ) from e
+
+    @classmethod
+    def try_coerce(
+        cls,
+        value: Self | str | object,
+    ) -> Self | None:
+        """
+        Attempt to coerce a value into the enum; return ``None`` on failure.
+
+        Parameters
+        ----------
+        value : Self | str | object
+            An existing enum member or a string-like value to normalize.
+
+        Returns
+        -------
+        Self | None
+            The corresponding enum member, or ``None`` if coercion fails.
+        """
+        try:
+            return cls.coerce(value)
+        except (ValueError, TypeError, KeyError):
+            return None

{etlplus-0.16.2 → etlplus-0.16.4}/etlplus/ops/__init__.py

@@ -52,6 +52,7 @@ from .validate import validate
 
 
 __all__ = [
+    # Functions
     'extract',
     'load',
     'run',

{etlplus-0.16.2/etlplus → etlplus-0.16.4/etlplus/ops}/enums.py

@@ -1,133 +1,30 @@
 """
-:mod:`etlplus.enums` module.
+:mod:`etlplus.ops.enums` module.
 
-Shared enumeration types used across ETLPlus modules.
+Operation-specific enums and helpers.
 """
 
 from __future__ import annotations
 
-import enum
 import operator as _op
 from statistics import fmean
-from typing import Self
 
+from ..enums import CoercibleStrEnum
+from ..types import StrStrMap
 from .types import AggregateFunc
 from .types import OperatorFunc
-from .types import StrStrMap
 
-# SECTION: EXPORTS ========================================================== #
+# SECTION: EXPORTS ========================================================= #
 
 
 __all__ = [
     # Enums
     'AggregateName',
-    'CoercibleStrEnum',
     'OperatorName',
     'PipelineStep',
 ]
 
 
-# SECTION: CLASSES ========================================================== #
-
-
-class CoercibleStrEnum(enum.StrEnum):
-    """
-    StrEnum with ergonomic helpers.
-
-    Provides a DRY, class-level :meth:`coerce` that normalizes inputs and
-    produces consistent, informative error messages. Also exposes
-    :meth:`choices` for UI/validation and :meth:`try_coerce` for soft parsing.
-
-    Notes
-    -----
-    - Values are normalized via ``str(value).strip().casefold()``.
-    - Error messages enumerate allowed values for easier debugging.
-    """
-
-    # -- Class Methods -- #
-
-    @classmethod
-    def aliases(cls) -> StrStrMap:
-        """
-        Return a mapping of common aliases for each enum member.
-
-        Subclasses may override this method to provide custom aliases.
-
-        Returns
-        -------
-        StrStrMap
-            A mapping of alias names to their corresponding enum member names.
-        """
-        return {}
-
-    @classmethod
-    def choices(cls) -> tuple[str, ...]:
-        """
-        Return the allowed string values for this enum.
-
-        Returns
-        -------
-        tuple[str, ...]
-            A tuple of allowed string values for this enum.
-        """
-        return tuple(member.value for member in cls)
-
-    @classmethod
-    def coerce(cls, value: Self | str | object) -> Self:
-        """
-        Convert an enum member or string-like input to a member of *cls*.
-
-        Parameters
-        ----------
-        value : Self | str | object
-            An existing enum member or a text value to normalize.
-
-        Returns
-        -------
-        Self
-            The corresponding enum member.
-
-        Raises
-        ------
-        ValueError
-            If the value cannot be coerced into a valid member.
-        """
-        if isinstance(value, cls):
-            return value
-        try:
-            normalized = str(value).strip().casefold()
-            resolved = cls.aliases().get(normalized, normalized)
-            return cls(resolved)  # type: ignore[arg-type]
-        except (ValueError, TypeError) as e:
-            allowed = ', '.join(cls.choices())
-            raise ValueError(
-                f'Invalid {cls.__name__} value: {value!r}. Allowed: {allowed}',
-            ) from e
-
-    @classmethod
-    def try_coerce(
-        cls,
-        value: object,
-    ) -> Self | None:
-        """
-        Best-effort parse; return ``None`` on failure instead of raising.
-
-        Parameters
-        ----------
-        value : object
-            An existing enum member or a text value to normalize.
-
-        Returns
-        -------
-        Self | None
-            The corresponding enum member, or ``None`` if coercion fails.
-        """
-        try:
-            return cls.coerce(value)
-        except ValueError:
-            return None
-
-
 # SECTION: ENUMS ============================================================ #
 
 

{etlplus-0.16.2 → etlplus-0.16.4}/etlplus/ops/run.py

@@ -11,14 +11,14 @@ from typing import Final
 from typing import cast
 
 from ..api import HttpMethod
+from ..config import Config
 from ..connector import DataConnectorType
 from ..file import FileFormat
+from ..ops.types import PipelineConfig
 from ..types import JSONData
 from ..types import JSONDict
-from ..types import PipelineConfig
 from ..types import StrPath
 from ..utils import print_json
-from ..workflow import load_pipeline_config
 from .extract import extract
 from .extract import extract_from_api_source
 from .load import load
@@ -176,7 +176,7 @@ def run(
         If the job is not found or if there are configuration issues.
     """
     cfg_path = config_path or DEFAULT_CONFIG_PATH
-    cfg = load_pipeline_config(cfg_path, substitute=True)
+    cfg = Config.from_yaml(cfg_path, substitute=True)
 
     # Lookup job by name
     if not (job_obj := next((j for j in cfg.jobs if j.name == job), None)):